Skip to content

Latest commit

 

History

History
64 lines (63 loc) · 29.5 KB

apidocs.md

File metadata and controls

64 lines (63 loc) · 29.5 KB
模块 接口名称 请求URL 请求类型 请求参数类型 请求参数 q请求结果
CI模型分类管理 查询列表(展开树) /topo/modelClassification/treeList POST application/json { "classificationName": "", "status": "" //状态 } { "code": 200, "msg": "success", "success": true, "data": [] }
CI模型分类管理 查询列表(展开下级) /topo/modelClassification/objCommon GET application/json classificationId=OBJ-CLASS-5 如果无参数,默认查根 { "code": 200, "msg": "success", "success": true, "data": [] }
CI模型分类管理 新增CI模型分类 /topo/modelClassification/save POST application/json { "parentId": "OBJ-CLASS-5", "parentName": "二级分类2", "classificationName": "三级分类2", "orderBy": "2", "status": "1", //状态:1正常 2停用 "describe": "描述内容..", "level": "3" //等级 } { "code": 200, "msg": "success", "success": true, "data": true }
CI模型分类管理 编辑CI模型分类 /topo/modelClassification/update POST application/json { "id": 6, //修改的分类id "parentId": "-", "parentName": "-", "classificationId": "OBJ-CLASS-6", "classificationName": "根目录4", "orderBy": 3, "status": "0", //状态 "describe": "fff" } { "code": 200, "msg": "success", "success": true, "data": true }
CI模型分类管理 删除模型分类 /topo/modelClassification/del GET application/json id=1 { "code": 200, "msg": "success", "success": true, "data": true }
CI模型分类管理 导入模型分类 /topo/modelClassification/importObjClass POST multipart/form-data 文件 { "code": 200, "msg": "success", "success": true, "data": true } [断言]: 1.状态断言:返回码为200 2.业务断言:"data"值中"msg"值包含"导入成功"
CI模型分类管理 导出模型分类 /topo/modelClassification/exportObjClass GET multipart/form-data { "code": 200, "msg": "success", "success": true, "data": true } [断言]: 1.状态断言:返回码为200 2.业务断言:"data"值中"msg"值包含"导出成功"
CI模型分类管理 下载模板 /topo/modelClassification/downLoadTemplate GET application/json
CI模型管理 获取模型列表 /topo/obj/getObjList POST application/json { "pageNum": 1, "pageSize": 20, "classificationId": "", //分类ID "objName": "", //模型名称 "ispaused": "", //状态(true-停用 false-启用) "description": "", //描述 "creator": "", //创建人 "createStartTime": "", //创建开始时间 "createEndTime": "", //创建结束时间 "label": "" //标签 } { "code": 200, "msg": "success", "success": true, "data": [] }
CI模型管理 新增CI模型 /topo/obj/saveObj POST application/json { "classificationId": "OBJ-CLASS-3", //模型分类ID "classificationName": "根目录3", //模型分类名称 "objIcon": "icon-cc-host", //模型图标 "objName": "数据中心000", //模型名称 "ispaused": false, //状态(true-停用 false-启用) "description": "主机管理模型" //描述 } { "code": 200, "msg": "success", "success": true, "data": [] }
CI模型分类管理 编辑CI模型 /topo/obj/updateObj POST application/json { "id": 3, //模型序列Id "objName": "主机2号", //模型名称 "ispaused": true, //状态(true-停用 false-启用)--停用启用是同一个接口 "classificationId": "", //模型分类id "classificationName": "" //模型分类名称 } { "code": 200, "msg": "success", "success": true, "data": [] }
CI模型管理 删除CI模型 /topo/obj/delObj DELETE application/json { "id": 7 //模型id } { "code": 200, "msg": "success", "success": true, "data": [] }
CI模型管理 查看CI模型详情 /topo/obj/getObjDetailById GET application/json id=9 { "code": 200, "msg": "success", "success": true, "data": [] }
CI模型管理 获取模型段落 /topo/paragraph/getParagraphList POST application/json { "objId": "host" //模型ID } { "code": 200, "msg": "success", "success": true, "data": [] }
CI模型管理 新增模型段落 /paragraph/saveParagraph POST application/json { "groupName": "主机标签", //段落名称 "objId": "host", //模型ID "isCollapse": true, //是否为标签(true--是 false--不是) "groupIndex": 1 //段落排序 } { "code": 200, "msg": "success", "success": true, "data": [] }
CI模型管理 修改模型段落 /topo/paragraph/updateParagraph POST application/json { "id": 2, //段落id "groupName": "主机参数", //段落名称 "objId": "host", //模型唯一标识 "groupIndex": 0, //段落排序 "isCollapse": false } { "code": 200, "msg": "success", "success": true, "data": [] }
CI模型管理 删除模型段落 /topo/paragraph/delParagraph DELETE application/json { "id": 0 //段落id } { "code": 200, "msg": "success", "success": true, "data": [] }
CI模型管理 获取模型字段列表 /topo/objFiled/getObjFiledList POST application/json { "objId": "host" //字段所属模型唯一标识 } { "code": 200, "msg": "success", "success": true, "data": [] }
CI模型管理 新增模型字段 /topo/objFiled/saveObjFiled POST application/json { "propertyName": "参数1", //字段名称 "propertyId": "OBJ-3", "unit": "", //单位 "placeholder": "", //用户提示 "propertyType": "singlechar", //字段类型 "editable": false, //是否可编辑 "isrequired": true, //是否必填 "option": "", //正则校验 "creator": "admin", //创建人 "propertyGroup": "PropertyGroup-9", //字段所属段落分组 "objId": "host" //字段所属模型唯一标识 } { "code": 200, "msg": "success", "success": true, "data": [] }
CI模型管理 修改模型字段 /topo/objFiled/saveObjFiled POST application/json { "propertyName": "参数1", //字段名称 "propertyId": "OBJ-3", "unit": "", //单位 "placeholder": "", //用户提示 "propertyType": "singlechar", //字段类型 "editable": false, //是否可编辑 "isrequired": true, //是否必填 "option": "", //正则校验 "creator": "admin", //创建人 "propertyGroup": "PropertyGroup-9", //字段所属段落分组 "objId": "host" //字段所属模型唯一标识 } { "code": 200, "msg": "success", "success": true, "data": [] }
CI模型管理 删除模型字段 /topo/objFiled/delObjFiled DELETE application/json { "id": 15 //字段id } { "code": 200, "msg": "success", "success": true, "data": [] }
CI模型管理 新增标签字段 /topo/objFiled/saveObjLable POST application/json { "objId": "host", //字段所属模型唯一标识 "lableId": "lable6", //标签唯一标识 "lableName": "标签字段6" //标签名称 } { "code": 200, "msg": "success", "success": true, "data": [] }
CI模型管理 编辑标签字段 /topo/objFiled/updateObjLable POST application/json { "id": 7, "objId": "dcCenter", "lableId": "c", "lableName": "cc2222" } { "code": 200, "msg": "success", "success": true, "data": [] }
CI模型管理 删除标签字段 /topo/objFiled/delObjLable POST application/json { "id": 15, //字段id "objId": "dcCenter" } { "code": 200, "msg": "success", "success": true, "data": [] }
CI模型管理 新增测点字段列 /topo/pointFieldColumn/savePointFiledColumn POST application/json { "objId": "dcCenter", //模型ID "pointId": "dc_area11", //测点字段ID "pointName": "数据中心面积2", //测点字段名称 "pointType": "singlechar", //测点字段类型 "pointIndex": 1, //字段排序 "unit": "", "creator": "admin", //创建人 "createTime": "", //创建时间 "lastTime": "", //修改时间 "defaultContent": "", //默认内容 "decimalAllowed": "", //允许小数 "limitWords": "", //限制字数 "addOptions": "", //添加选项 "displayFormat": "", //显示格式 "associatedContent": "", //关联内容 "allowRepetition": "", //允许重复 "option": "", //字段正则校验 "editable": "", //字段是否可编辑 "isrequired": "", //字段是否必填 "placeholder": "" //字段提示 } { "code": 200, "msg": "success", "success": true, "data": [] }
CI模型管理 修改测点字段列 /topo/pointFieldColumn/updatePointFiledColumn POST application/json { "id": 0, "objId": "dcCenter", //模型ID "pointId": "dc_area22", //测点字段ID "pointName": "数据中心面积", //测点字段名称 "pointType": "singlechar", //测点字段类型 "pointIndex": 0, //字段排序 "unit": "", "creator": "admin", //创建人 "createTime": "", //创建时间 "lastTime": "", //修改时间 "defaultContent": "", //默认内容 "decimalAllowed": "", //允许小数 "limitWords": "", //限制字数 "addOptions": "", //添加选项 "displayFormat": "", //显示格式 "associatedContent": "", //关联内容 "allowRepetition": "", //允许重复 "option": "", //字段正则校验 "editable": "", //字段是否可编辑 "isrequired": "", //字段是否必填 "placeholder": "" //字段提示 } { "code": 200, "msg": "success", "success": true, "data": [] }
CI模型管理 删除测点字段列 /topo/pointFieldColumn/delPointFiledColumn POST application/json { "id": 0 //测点列id } { "code": 200, "msg": "success", "success": true, "data": [] }
CI模型管理 新增测点字段行 /topo/pointFieldLine/savePointFiledLine POST application/json { "objId": "dcCenter", //模型ID "pointColumnId": 2, //测点字段列ID "pointLineId": "", //测点字段行ID "pointValue": "2222", //测点字段行值 "pointIndex": 0, "creator": "admin", //创建人 "createTime": "", //创建时间 "updateName": "", //修改人 "updateTime": "" } { "code": 200, "msg": "success", "success": true, "data": [] }
CI模型管理 修改测点字段行 /topo/pointFieldLine/updatePointFiledLine POST application/json { "id": 0, "objId": "dcCenter", //模型ID "pointColumnId": 1, //测点字段列ID "pointLineId": 0, //测点字段行ID "pointValue": "2233", //测点字段行值 "pointValueIndex": 0, //字段排序 "creator": "admin", //创建人 "createTime": "", //创建时间 "updateName": "", //修改人 "updateTime": "" } { "code": 200, "msg": "success", "success": true, "data": [] }
CI模型管理 删除测点字段行 /topo/pointFieldLine/delPointFiledLine POST application/json { "id": 0 } { "code": 200, "msg": "success", "success": true, "data": [] }
CI模型管理 获取测点字段列表 /topo/pointFieldColumn/getPointFieldList POST application/json { "objId": "dcCenter" //模型id } { "code": 200, "msg": "success", "success": true, "data": [] }
CI模型管理 新增测点数据源 /topo/pointFieldLine/savePointData POST application/json { "lineId": 1, //行id "objId": "OBJ-31", //模型id "我i是标题": "列value3", "我是标题": "列value3" } { "code": 200, "msg": "success", "success": true, "data": [] }
CI模型管理 获取测点数据源 /topo/pointFieldLine/getPointData GET application/json { "code": 200, "msg": "success", "success": true, "data": [] }
CI模型关系 创建模型关系 /topo/objAsst/createObjAsst POST application/json { "edges": [ { "id": "c5def6fc-9c2b-4f75-aa9d-d7c7123e90f", "type": "htmlEdge", "sourceNodeId": "7b09dd69-2611-4f99-bf39-20c61715ec6", "targetNodeId": "002cd3a6-e48f-4de8-86b4-ac662146054", "properties": { "isActived": false, "objId": "OBJ-31", "asstObjId": "OBJ-26", "asstId": "GXLX-2", "mapping": "1-N" }, "text": { "value": "边的文案" } } ], "nodes": [ { "id": "7b09dd69-2611-4f99-bf39-20c61715ec6", "type": "htmlNode", "properties": { "id": "nodee019bb67-b13d-4ba1-bd3a-5fc25f17269", "text": "Level one 1节点", "modeId": "OBJ-31" } }, { "id": "002cd3a6-e48f-4de8-86b4-ac662146054", "type": "htmlNode", "properties": { "id": "node10e9e4a8-1e68-4eca-b228-2d297992975", "text": "Level one 1节点", "modeId": "OBJ-26" } } ] } { "code": 200, "msg": "success", "success": true, "data": [] }
CI模型关系 删除模型关系 /topo/objAsst/deleteObjAsst/OBJ-31_GXLX-2_OBJ-26 DELETE multipart/form-data { "code": 200, "msg": "success", "success": true, "data": [] }
CI模型关系 获取模型关系列表 /topo/objAsst/listObjAsst POST application/json { "objId": "OBJ-25", "page": 1, "size": 10 } { "code": 200, "msg": "success", "success": true, "data": [] }
CI模型关系 获取全局拓扑 /topo/objAsst/getAllObjTopo GET multipart/form-data { "code": 200, "msg": "success", "success": true, "data": [] }
CI模型关系 获取局部拓扑 /topo/objAsst/getObjPartTopo/OBJ-25 GET multipart/form-data { "code": 200, "msg": "success", "success": true, "data": [] }
CI模型关系 编辑拓扑 /topo/objAsst/updateObjTopo/true POST application/json { "edges": [ { "id": "c5def6fc-9c2b-4f75-aa9d-d7c7123e90", "type": "htmlEdge", "sourceNodeId": "7b09dd69-2611-4f99-bf39-20c617", "targetNodeId": "002cd3a6-e48f-4de8-86b4-ac662146", "properties": { "isActived": false, "objId": "dcCenter", "asstObjId": "OBJ-31", "asstId": "GXLX-2", "mapping": "1-N", "modeId": "dcCenter_GXLX-2_OBJ-31" }, "text": { "value": "关联关系编辑" } } ], "nodes": [ { "id": "7b09dd69-2611-4f99-bf39-20c617", "type": "htmlNode", "properties": { "id": "nodee019bb67-b13d-4ba1-bd3a-5fc25f1", "text": "Level one 1节点", "modeId": "dcCenter" } }, { "id": "002cd3a6-e48f-4de8-86b4-ac662146", "type": "htmlNode", "properties": { "id": "node10e9e4a8-1e68-4eca-b228-2d297992", "text": "Level one 1节点", "modeId": "OBJ-31" } } ] } { "code": 200, "msg": "success", "success": true, "data": [] }
CI模型关系 局部高亮 /topo/objAsst/getOjbByClass POST application/json { "classId": "OBJ-CLASS-3", "objId": "", "nodeIds": [ "7b09dd69-2611-4f99-bf39-20c61715ec61" ] } { "code": 200, "msg": "success", "success": true, "data": [] }
CI实例 获取实例列表页 /topo/instance/list POST application/json { "classificationId": "", //分类id "objId": "", //模型id "insName": "", //实例名称 "customize": {}, //下拉其他字段 "modelLabelName": "", //模型标签 "creater": "", //创建人 "createStartTime": "", //创建开始时间 "createEndTime": "", //创建结束时间 "asstType": "", //关系类型 "page": 0, "size": 10 } { "code": 200, "msg": "success", "success": true, "data": [] }
CI实例 新建CI实例 /topo/instance/save POST application/json { "insName": "", //实例名称 "objId": "", //模型id "objName": "", //模型名称 "classificationId": "", //分类id "classificationName": "", //分类名称 "modelLabelName": "", //模型标签 "asstType": "", //关系类型 "insAttList": [], //字段数据 "insPointDataList": [] //测点数据 } { "code": 200, "msg": "success", "success": true, "data": [] }
CI实例 修改CI实例 /topo/instance/update POST application/json { "id": 1, "insId": "", //实例id "insName": "inst_name_11", //实例名称 "insAttList": [], //字段数据 "insPointDataList": [] //测点数据 } { "code": 200, "msg": "success", "success": true, "data": [] }
CI实例 删除CI实例 /topo/instance/del GET application/json insId=12345 { "code": 200, "msg": "success", "success": true, "data": [] }
CI实例 根据模型查询实例数 /topo/instance/getInsCountByObjId GET application/json ObjId=OBJ-26 { "code": 200, "msg": "success", "success": true, "data": [] }
CI实例关系 创建实例关系 /topo/insAsst/saveInsAsst POST application/json { "edges": [ { "id": "c5def6fc-9c2b-4f75-aa9d", "type": "htmlEdge", "sourceNodeId": "7b09dd69-2611-4f99-bf39", "targetNodeId": "002cd3a6-e48f-4de8-86b4", "properties": { "isActived": false, "objAsstId": "OBJ-25_GXLX-2_OBJ-26", "insId": "inst_id_1", "asstId": "GXLX-2", "asstInsId": "inst_id_2" }, "text": { "value": "实例关系" } } ], "nodes": [ { "id": "7b09dd69-2611-4f99-bf39", "type": "htmlNode", "properties": { "id": "nodee019bb67-b13d-4ba1-bd3a", "text": "Level one 1节点", "modeId": "inst_id_1" } }, { "id": "002cd3a6-e48f-4de8-86b4", "type": "htmlNode", "properties": { "id": "node10e9e4a8-1e68-4eca-b228", "text": "Level one 1节点", "modeId": "inst_id_2" } } ] } { "code": 200, "msg": "success", "success": true, "data": [] }
CI实例关系 删除实例关系 /topo/insAsst/deleteInsAsst/inst_id_1_GXLX-2_inst_id_2 DELETE multipart/form-data { "code": 200, "msg": "success", "success": true, "data": [] }
CI实例关系 查询目标实例列表 /topo/insAsst/listAsstIns POST application/json { "insId": "inst_id_1", "insName": null, "objAsstId": "OBJ-25_GXLX-2_OBJ-26", "objId": "OBJ-26", "page": 1, "propertyId": null, "propertyValue": null, "size": 10, "sort": null } { "code": 200, "msg": "success", "success": true, "data": [] }
CI实例关系 查询实例关联关系列表 /topo/insAsst/listInsAsst POST application/json { "insId": "inst_id_1", "page": 1, "size": 10 } { "code": 200, "msg": "success", "success": true, "data": [] }
CI实例关系 查询实例所属模型 /topo/insAsst/listBelongObj/inst_id_1 GET application/json { "code": 200, "msg": "success", "success": true, "data": [] }
CI实例关系 查询全局拓扑 /topo/insAsst/getAllInsTopo GET application/json { "code": 200, "msg": "success", "success": true, "data": [] }
CI实例关系 查询局部拓扑 /topo/insAsst/getInsPartTopo/inst_id_1 GET application/json { "code": 200, "msg": "success", "success": true, "data": [] }
CI实例关系 编辑拓扑图 /topo/insAsst/updateInsTopo/true POST application/json { "edges": [ { "id": "c5def6fc-9c2b-4f75-aa9d", "type": "htmlEdge", "sourceNodeId": "7b09dd69-2611-4f99-bf39", "targetNodeId": "002cd3a6-e48f-4de8-86b4", "properties": { "isActived": false, "objAsstId": "OBJ-25_GXLX-2_OBJ-26", "insId": "inst_id_1", "asstId": "GXLX-2", "asstInsId": "inst_id_2", "modeId": "inst_id_1_GXLX-2_inst_id_2" }, "text": { "value": "实例关系" } } ], "nodes": [ { "id": "7b09dd69-2611-4f99-bf39", "type": "htmlNode", "properties": { "id": "nodee019bb67-b13d-4ba1-bd3a", "text": "Level one 1节点", "modeId": "inst_id_1" } }, { "id": "002cd3a6-e48f-4de8-86b4", "type": "htmlNode", "properties": { "id": "node10e9e4a8-1e68-4eca-b228", "text": "Level one 1节点", "modeId": "inst_id_2" } } ] } { "code": 200, "msg": "success", "success": true, "data": [] }
CI实例关系 全局高亮 /topo/insAsst/getHighLightIns POST application/json { "asstId": null, "classId": null, "insName": null, "level": null, "objName": null } { "code": 200, "msg": "success", "success": true, "data": [] }
CI实例关系 局部高亮 /topo/insAsst/getInsByObjOrClass POST application/json { "objId": "", "classId": "dcCenterManger" } { "code": 200, "msg": "success", "success": true, "data": [] }
报表-操作审计 获取操作审计列表 /topo/audit/list POST application/json { "page": 1, //分页页码,数字类型 "size": 10, //分页条数 "resourceType": "", "action": "", //动作 "operationStartTime": "2022-04-12", //操作开始时间 "operationEndTime": "2022-04-13", //操作结束时间 "operationId": "" } { "code": 200, "msg": "success", "success": true, "data": [] }
报表-操作审计 查询实例操作记录 /topo/audit/listByInstId?instId=1 POST application/json { "code": 200, "msg": "success", "success": true, "data": [] }
配置-关系类型配置 列表查询 /topo/associationType/listAsst POST application/json { "page": 1, "size": 10, "asstName": "", "createName": null, "startTime": "", "endTime": "" } { "code": 200, "msg": "success", "success": true, "data": [] }
配置-关系类型配置 新增关系 /topo/associationType/createAsst POST application/json { "asstName": "邱自测5", "srcDes": "源到目标描述4", "destDes": "目标到源描述4", "direction": "src_to_dest" } { "code": 200, "msg": "success", "success": true, "data": [] }
配置-关系类型配置 编辑关系 /topo/associationType/updateAsst POST application/json { "asstId": "GXLX-21", "asstName": "邱自测100", "srcDes": "源到目标描述1---1", "destDes": "目标到源描述1---2", "direction": "src_to_dest" } { "code": 200, "msg": "success", "success": true, "data": [] }
配置-关系类型配置 删除关系 /topo/associationType/deleteAsstType/GXLX-20 POST multipart/form-data { "code": 200, "msg": "success", "success": true, "data": [] }