作者:管理员  历史版本:1  最后编辑:龚清  更新时间:2025-10-14 18:31
根据Id查询变量数据
简述:
- 根据Id查询变量数据
 
请求URL:
- http://ip:port/ibps/platform/v3/codegen/variable/get
 - URL中的ip需要替换为自己网关ip
 - URL中的port需要替换为自己网关端口
 
请求方式:
- GET
 
请求参数:
- Headers:
 
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | 
|---|---|---|---|---|---|
| X-Authorization-access_token | String | 是 | 系统令牌 | 
- Query:
 
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | 
|---|---|---|---|---|---|
| userId | String | 是 | 用户id | 
- Body:
 
暂无
请求参数示例:
http://192.168.3.230:15100/ibps/business/v3/codegen/variable/get?id=332575628714835965返回示例:
{
    "state": 200,
    "request": null,
    "message": "",
    "cause": "",
    "variables": {},
    "data": {
        "pk": "",
        "name": "公司名称",
        "ip": null,
        "createBy": null,
        "createTime": 1488455690000,
        "updateBy": null,
        "updateTime": null,
        "tenantId": "-999",
        "dataStatus": null,
        "dbtype": null,
        "id": "332575628714835965",
        "key": "company",
        "value": "广州流辰信息技术有限公司",
        "comment": "生成注释使用",
        "type": "global",
        "schemeId": null,
        "creator": "1",
        "deletable": "N",
        "dataType": "init",
        "creatorName": null
    }
}返回参数说明:
| 名称 | 类型 | 备注 | 
|---|---|---|
| data | VariablePo | 变量,全局、私有。 实体对象 | 
查询变量列表(分页条件查询)数据
简述:
- 查询变量列表(分页条件查询)数据
 
请求URL:
- http://ip:port/ibps/platform/v3/codegen/variable/query
 - URL中的ip需要替换为自己网关ip
 - URL中的port需要替换为自己网关端口
 
请求方式:
- 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": [
            {
                "pk": "",
                "name": "doType",
                "ip": null,
                "createBy": null,
                "createTime": 1577062243000,
                "updateBy": null,
                "updateTime": null,
                "tenantId": "-999",
                "dataStatus": null,
                "dbtype": null,
                "id": "658592310317023232",
                "key": "doType",
                "value": "default",
                "comment": "doType",
                "type": "default",
                "schemeId": null,
                "creator": "654755459927900160",
                "deletable": "Y",
                "dataType": "add",
                "creatorName": "黄春艳"
            },
            {
                "pk": "",
                "name": "模块名",
                "ip": null,
                "createBy": null,
                "createTime": 1577062243000,
                "updateBy": null,
                "updateTime": null,
                "tenantId": "-999",
                "dataStatus": null,
                "dbtype": null,
                "id": "658592310472212480",
                "key": "module",
                "value": "codegen",
                "comment": "模块名",
                "type": "default",
                "schemeId": null,
                "creator": "654755459927900160",
                "deletable": "Y",
                "dataType": "add",
                "creatorName": "黄春艳"
            },
            {
                "pk": "",
                "name": "是否基础模块",
                "ip": null,
                "createBy": null,
                "createTime": 1577062243000,
                "updateBy": null,
                "updateTime": null,
                "tenantId": "-999",
                "dataStatus": null,
                "dbtype": null,
                "id": "658592310572875776",
                "key": "isBaseModule",
                "value": "false",
                "comment": "是否基础模块",
                "type": "default",
                "schemeId": null,
                "creator": "654755459927900160",
                "deletable": "Y",
                "dataType": "add",
                "creatorName": "黄春艳"
            }
        ],
        "pageResult": {
            "limit": 3,
            "page": 1,
            "totalCount": 50,
            "totalPages": 17
        }
    }
}返回参数说明:
| 名称 | 类型 | 备注 | 
|---|---|---|
| data | APIPageList< VariablePo > | 变量,全局、私有。 实体对象 | 
变量初始化
简述:
- 变量初始化
 
请求URL:
- http://ip:port/ibps/platform/v3/codegen/variable/refresh
 - URL中的ip需要替换为自己网关ip
 - URL中的port需要替换为自己网关端口
 
请求方式:
- POST
 
请求参数:
- Headers:
 
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | 
|---|---|---|---|---|---|
| X-Authorization-access_token | String | 是 | 系统令牌 | 
- Query:
 
暂无
- Body:
 
暂无
请求参数示例:
无返回示例:
{
    "state": 200,
    "request": null,
    "message": "",
    "cause": "",
    "variables": {},
    "data": null
}返回参数说明:
| 名称 | 类型 | 备注 | 
|---|---|---|
| data | Void | 
删除变量数据
简述:
- 删除变量数据
 
请求URL:
- http://ip:port/ibps/platform/v3/codegen/variable/remove
 - URL中的ip需要替换为自己网关ip
 - URL中的port需要替换为自己网关端口
 
请求方式:
- GET
 
请求参数:
- Headers:
 
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | 
|---|---|---|---|---|---|
| X-Authorization-access_token | String | 是 | 系统令牌 | 
- Query:
 
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | 
|---|---|---|---|---|---|
| ids | String[] | 是 | 变量id | 
- Body:
 
暂无
请求参数示例:
http://192.168.3.230:15100/ibps/business/v3/codegen/variable/remove?ids=676818402521645056返回示例:
{
    "state": 200,
    "request": null,
    "message": "",
    "cause": "",
    "variables": {},
    "data": null
}返回参数说明:
| 名称 | 类型 | 备注 | 
|---|---|---|
| data | Void | 
保存变量
简述:
- 保存变量
 
请求URL:
- http://ip:port/ibps/platform/v3/codegen/variable/save
 - URL中的ip需要替换为自己网关ip
 - URL中的port需要替换为自己网关端口
 
请求方式:
- POST
 
请求参数:
- Headers:
 
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 | 
|---|---|---|---|---|---|
| X-Authorization-access_token | String | 是 | 系统令牌 | 
- Query:
 
暂无
- Body:
 
VariablePo 对象信息
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 
|---|---|---|---|---|
| id | String | 否 | 主键 | |
| key | String | 是 | 变量key | |
| name | String | 是 | 变量名 | |
| value | String | 是 | 变量值 | |
| comment | String | 否 | 变量描述 | |
| type | String | 是 | 变量类型:global-全局、default-默认、private-私有 | |
| schemeId | String | 否 | 方案ID | |
| creator | String | 是 | 创建人 | |
| deletable | String | 否 | 可删除 | |
| dataType | String | 否 | 数据类型,init、add… | |
| createTime | Date | 否 | 创建时间 | 
请求参数示例:
{
    "key": "test",
    "name": "test",
    "value": "test",
    "type": "global",
    "comment": "",
    "creator": "654384477392338944"
}返回示例:
{
    "state": 200,
    "request": null,
    "message": "",
    "cause": "",
    "variables": {},
    "data": null
}返回参数说明:
| 名称 | 类型 | 备注 | 
|---|---|---|
| data | Void | 
备注
- [1] : APIRequest为动态查询请求对象,详情请移步全局请求格式