WEB接口

/cmdb/ci/category/create.mvc

@RequestMapping(value="create")
@ResponseBody
public java.lang.String create( CiCategory  category, boolean  isUseModel, String  choosedModelCode) throws com.otu.core.util.serialize.json.JSONException, java.io.IOException, org.dom4j.DocumentException

参     数:

参数名 类型 描述 是否必须
name String 类别名称,不能包含'/',如有需要可用'|'代替
code String 类别编号
description String 描述
parent.id String 父类别Id,系统不允许创建一级类别,因此,此属性不可为空
icon String 图标
url3dmodel String 3D模型标识
hidden boolean 是否隐藏类别
isUseModel boolean 是否使用模型
choosedModelCode String 选择的模型

返 回 值:

  描述 范例
成功 新类别的明细信息 {
  success : true,    
  root :{  id : xxx, name :xxx, icon : xxx  }
}
失败 错误信息 {  success : false,  msg : xxx,  code : xxx  }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据序列化异常
java.io.IOException 输入输出异常
org.dom4j.DocumentException xml解析异常

示     例:

    $.ajax({
        url : "/cmdb/ci/category/create.mvc", 
        type : "post",
        data : {
            'name':"测试",
            'code':"cagt_2_test",
            'parent.id' : 'xxx'
        }, 
        dataType : "json", 
        success : function(data) { 
            alert(data);
        }
    });

/cmdb/ci/category/update.mvc

@RequestMapping(value="update")
@ResponseBody
public String update(CiCategory category) throws JSONException

参     数:

参数名 类型 描述 是否必须
id String 类别id
name String 类别必须包含一个非空的name属性
code String 编号
description String 描述
parent.id String 父类别Id,系统不允许创建和修改一级类别,因此,此属性不能为空
icon String 图标
url3dmodel String 3D模型标识
hidden boolean 是否隐藏类别

返 回 值:

  描述 范例
成功 新类别的明细信息 {
  success : true,
  root :{  id : xxx,  name :xxx,  icon : xxx  }
}
失败 错误信息 {   success : false,   msg : xxx,   code : xxx }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据序列化异常

示     例:

    $.ajax({
        url : "/cmdb/ci/category/update.mvc",
        type : "post",
        data : {
            'id':"xxx" ,
            'name':"测试",
            'parent.id':"xxx"
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });

/cmdb/ci/category/get.mvc

指定一个类别的ID,获取该类别的明细信息,明细信息包括:

  • ID
  • 名称 NAME
  • 编号 CODE
  • 描述 DESCRIPTION
  • 父类别 PARENT
  • 图标 ICON
  • 3D模型 3D_MODEL
  • 是否隐藏类别 IS_HIDDEN
  • 模型定义 MODEL_DEFINITION
  • 最近修改人 UPDATED_BY
  • 最近修改时间 UPDATED_ON
  • 创建人 CREATED_BY
  • 创建时间 CREATED_ON

使用者可以指定返回的类别中包含的信息,例如:指仅返回ID NAME CODE。

@RequestMapping(value="get")
@ResponseBody
public String get(String id, String code, String[] attrs) throws JSONException

参     数:

参数名 类型 描述 是否必须
id String 类别id,与code任选一个即可,同时存在以id为准
code String 类别code,与id任选一个即可,同时存在以id为准
attrs String 需要返回的属性名称,不指定attrs表示返回全部属性。 attrs 的可选范围:
  • id
  • name
  • code
  • description
  • parent
  • icon
  • modelDefinition
  • url3dmodel
  • hidden
  • updatedBy
  • updatedOn
  • createdBy
  • createdOn

多个可选值用逗号分隔,如:name,code,description,icon

返 回 值:

  描述 范例
成功 类别的明细信息 {
  success : true,
  root :{  id : xxx,  name :xxx,  icon : xxx  }
}
失败 错误信息 {   success : false,   msg : xxx,   code : xxx }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据序列化异常

示例:

    $.ajax({
        url : "/cmdb/ci/category/get.mvc",
        type : "post",
        data : {
            id: "402881d6483f64c601483f64e31b0000"
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });
    
    $.ajax({
        url : "/cmdb/ci/category/get.mvc",
        type : "post",
        data : {
            code: "xxx"
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });

/cmdb/ci/category/list.mvc

获取CMDB所有分类的数据,数据能表达分类的层次关系,单个类别可返回的信息包括:

  • ID
  • 名称 NAME
  • 编号 CODE
  • 描述 DESCRIPTION
  • 父类别 PARENT
  • 图标 ICON
  • 3D模型 3D_MODEL
  • 是否隐藏类别 IS_HIDDEN
  • 模型定义 MODEL_DEFINITION
  • 最近修改人 UPDATED_BY
  • 最近修改时间 UPDATED_ON
  • 创建人 CREATED_BY
  • 创建时间 CREATED_ON

使用者可以指定返回的类别中包含的信息,例如:指仅返回ID NAME CODE。

某人情况获取所有分类,用户可以指定获取的层次级别

@RequestMapping(value="list")
@ResponseBody
public java.lang.String list( java.util.Map<String, Object>  props, boolean  containHidden, java.lang.String[] attrs) throws com.otu.core.util.serialize.json.JSONException

参     数:

参数名 类型 描述 是否必须
props Map<String, Object> 配置项属性列表
containHidden boolean 是否查询隐藏的类别,默认值为false
attrs String 需要返回的属性名称,不指定attrs表示返回全部属性。 attrs 的可选范围:
  • id
  • name
  • code
  • description
  • parent
  • icon
  • modelDefinition
  • url3dmodel
  • hidden
  • updatedBy
  • updatedOn
  • createdBy
  • createdOn
多个可选值用逗号分隔,如:name,code,description,icon

返 回 值:

  描述 范例
成功 类别的明细信息 {
    success : true,
    total : xxx,
    root :[
        {
           id : xxx,
           name : xxx,
           icon : xxx,
           parent : xxx // parent 仅返回其id,而不是整个对象
         }
    ]
}
失败 错误信息 {   success : false,   msg : xxx,   code : xxx }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据序列化异常

示例:

    $.ajax({
        url : "/cmdb/ci/category/list.mvc",
        type : "post",
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });
                

/cmdb/ci/category/listSelfAndChildren.mvc

指定一个类别的ID或code,获取该类别及其子类别,该类别和子类的明细信息包括:

  • ID
  • 名称 NAME
  • 编号 CODE
  • 描述 DESCRIPTION
  • 父类别 PARENT
  • 图标 ICON
  • 3D模型 3D_MODEL
  • 是否隐藏类别 IS_HIDDEN
  • 模型定义 MODEL_DEFINITION
  • 最近修改人 UPDATED_BY
  • 最近修改时间 UPDATED_ON
  • 创建人 CREATED_BY
  • 创建时间 CREATED_ON

使用者可以指定返回的类别中包含的信息,例如:指仅返回ID NAME CODE。

使用者可以指定返回子类的层级,例如:仅一层、所有层次、固定层次

@RequestMapping(value="listSelfAndChildren")
@ResponseBody
public java.lang.String listSelfAndChildren(java.lang.String[] ids, java.lang.Boolean deepIn, boolean containHidden, java.lang.String[] attrs) throws com.otu.core.util.serialize.json.JSONException

参     数:

参数名 类型 描述 是否必须
id String 父类别id 与code必须存在一个,同时存在时以id作为查询条件
deepIn Boolean 是否级联查询子的子类别,默认值为false
containHidden boolean 是否查询隐藏的类别,默认值为false
attrs String 需要返回的属性名称,不指定attrs表示返回全部属性。 attrs 的可选范围:
  • id
  • name
  • code
  • description
  • parent
  • icon
  • modelDefinition
  • url3dmodel
  • hidden
  • updatedBy
  • updatedOn
  • createdBy
  • createdOn
多个可选值用数组传递

返 回 值:

  描述 范例
成功 类别的明细信息 {
    success : true,
    total : xxx,
    root :[
        {
           id : xxx,
           name : xxx,
           icon : xxx,
           parent : xxx // parent 仅返回其id,而不是整个对象
         }
    ]
}
失败 错误信息 {   success : false,   msg : xxx,   code : xxx   }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据序列化异常

/cmdb/ci/category/listChildren.mvc

指定一个类别的ID或code,获取该类别所有子类,子类的明细信息包括:

  • ID
  • 名称 NAME
  • 编号 CODE
  • 描述 DESCRIPTION
  • 父类别 PARENT
  • 图标 ICON
  • 3D模型 3D_MODEL
  • 是否隐藏类别 IS_HIDDEN
  • 模型定义 MODEL_DEFINITION
  • 最近修改人 UPDATED_BY
  • 最近修改时间 UPDATED_ON
  • 创建人 CREATED_BY
  • 创建时间 CREATED_ON

使用者可以指定返回的类别中包含的信息,例如:指仅返回ID NAME CODE。

使用者可以指定返回子类的层级,例如:仅一层、所有层次、固定层次

@RequestMapping(value="listChildren")
@ResponseBody
public java.lang.String listChildren(java.lang.String id, java.lang.String code, java.lang.Boolean deepIn, java.lang.String[] attrs) throws com.otu.core.util.serialize.json.JSONException

参     数:

参数名 类型 描述 是否必须
id String 父类别id 与code必须存在一个,同时存在时以id作为查询条件
code String 父类别code 与id必须存在一个,同时存在时以id作为查询条件
deepIn Boolean 是否级联查询子的子类别,默认值为false
attrs String 需要返回的属性名称,不指定attrs表示返回全部属性。 attrs 的可选范围:
  • id
  • name
  • code
  • description
  • parent
  • icon
  • modelDefinition
  • url3dmodel
  • hidden
  • updatedBy
  • updatedOn
  • createdBy
  • createdOn
多个可选值用数组传递

返 回 值:

  描述 范例
成功 类别的明细信息 {
    success : true,
    total : xxx,
    root :[
        {
           id : xxx,
           name : xxx,
           icon : xxx,
           parent : xxx // parent 仅返回其id,而不是整个对象
         }
    ]
}
失败 错误信息 {   success : false,   msg : xxx,   code : xxx   }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据序列化异常

示例:

    $.ajax({
        url : "/cmdb/ci/category/listChildren.mvc",
        type : "post",
        data : {
            id: "402881d6483f64c601483f64e31b0000",
            deepIn : false
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });
    
    $.ajax({
        url : "/cmdb/ci/category/listSelfAndChildren.mvc",
        type : "post",
        data : {
            ids: ["xxxxxx", "xxxxxx"],
            deepIn : true
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });
    
    $.ajax({
        url : "/cmdb/ci/category/listChildren.mvc",
        type : "post",
        data : {
            code: "xxx",
            deepIn : true
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });
                

/cmdb/ci/category/delete.mvc

删除类别并且 级联删除子类别定义, 如果存在该类别的ci,则删除失败 

@RequestMapping(value="delete")
@ResponseBody
public java.lang.String delete(String[] categoryId)

参     数:

参数名 类型 描述 是否必须
categoryId String[] 类别id数组

返 回 值:

  描述 范例
成功 删除成功 {   success : true   }
失败 删除失败 {   success : false   }

异    常:

编号 描述

示例:

    $.ajax({
        url : "/cmdb/ci/category/delete.mvc", 
        type : "post",
        data : { 
            categoryId: ["xxx","xx"] 
        }, 
        dataType : "json", 
        success : function(data) { 
            alert(data);
        }
    });

/cmdb/ci/category/isExistCode.mvc

@RequestMapping(value="isExistCode")
@ResponseBody
public java.lang.String isExistCode(java.lang.String code, java.lang.String exceptId)

参     数:

参数名 类型 描述 是否必须
code String 需要被判断字符串
exceptId String 需要排除的类别id

返 回 值:

  描述 范例
成功 显示是否存在 {   success : true,   exist : true|false   }
失败 失败信息 {   success : false,   msg : xxx,   code : xxx   }

异    常:

编号 描述

示例:

    $.ajax({
        url : "/cmdb/ci/category/isExistCode.mvc",
        type : "post",
        data : {
            code: "xxx",
            exceptId : 'xxx'
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });
                

/cmdb/ci/category/isExistName.mvc

@RequestMapping(value="isExistName")
@ResponseBody
public java.lang.String isExistName(java.lang.String code, java.lang.String exceptId, java.lang.String parentId)

参     数:

参数名 类型 描述 是否必须
code String 需要被判断字符串
exceptId String 需要排除的类别id
parentId String 父类别id

返 回 值:

  描述 范例
成功 显示是否存在 {   success : true,   exist : true|false   }
失败 失败信息 {   success : false,   msg : xxx,   code : xxx   }

异    常:

编号 描述

示例:

    $.ajax({
        url : "/cmdb/ci/category/isExistName.mvc",
        type : "post",
        data : {
            code: "xxx",
            exceptId : 'xxx',
            parentId : 'xxx'
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });
                

/cmdb/ci/category/getAncestorId.mvc

@RequestMapping(value="getAncestorId")
@ResponseBody
public java.lang.String getAncestorId(java.lang.String categoryId)

参     数:

参数名 类型 描述 是否必须
categoryId String 指定类别Id

返 回 值:

  描述 范例
成功 类别的明细信息 {
  success : true,
  root :{  id : xxx,  name :xxx,  icon : xxx  }
}
失败 错误信息 {   success : false,   msg : xxx,   code : xxx }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据序列化异常

示例:

    $.ajax({
        url : "/cmdb/ci/category/getAncestorId.mvc",
        type : "post",
        data : {
            categoryId: "xxx"
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });
                

/cmdb/ci/category/bindStatus.mvc

@RequestMapping(value="bindStatus")
@ResponseBody
public String bindStatus(String categoryId, String[] status)

参     数:

参数名 类型 描述 是否必须
categoryId String 需要绑定状态的类别id
status String[] 被绑定的状态列表

返 回 值:

  描述 范例
成功 绑定成功 {   success : true   }
失败 错误信息 {   success : false,   msg : xxx,   code : xxx   }

异    常:

编号 描述

示例:

    $.ajax({
        url : "/cmdb/ci/category/bindStatus.mvc",
        type : "post",
        data : {
            categoryId:"xxxxxx",
            status:[  'xxx', 'xxxx', 'xx' ]
        }, 
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });

/cmdb/ci/category/unbindStatus.mvc

@RequestMapping(value="unbindStatus")
@ResponseBody
public String unbindStatus(String categoryId, String[] status)

参     数:

参数名 类型 描述 是否必须
categoryId String 类别id
status String[] 状态列表

返 回 值:

  描述 范例
成功 绑定成功 {   success : true   }
失败 错误信息 {   success : false,   msg : xxx,   code : xxx   }

异    常:

编号 描述

示例:

    $.ajax({
        url : "/cmdb/ci/category/unbindStatus.mvc",
        type : "post",
        data : {
            categoryId:"xxxxxx",
            status:[  'xxx', 'xxxx', 'xx' ]
        }, 
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });

/cmdb/ci/category/definition/get.mvc

@RequestMapping(value="definition/get")
@ResponseBody
public java.lang.String getDefinition(java.lang.String id, java.lang.String code, java.lang.String type, Boolean cascadeParents)

参     数:

参数名 类型 描述 是否必须
id String 类别id 与code必须存在一个,同时存在时以id作为查询条件
code String 类别编码 与id必须存在一个,同时存在时以id作为查询条件
type String 定义文件类型 json|xml,目前只支持json格式
cascadeParents Boolean 标记当前类别不存在模型定义文件时,是否逐级往上查询父类别的模型定义文件,直到父类别存在模型定义文件为止;默认不逐级往上查询

返 回 值:

  描述 范例
成功 返回模型定义文件 {
    "id" : "402881d6483f64c601483f64e31b0002",
    "code" : "cagt_1_device",
    "properties" : [
        {"type" : "String","name" : "资产编号","code" : "assetNO","nullable" : true,"enumKey" : " "},
        {
            "name" : "产品信息",
            "code" : "productInfo",
            "isGroup" : true,
            "properties" : [
                {"type" : "Product", "name" : "产品", "code" : "product", "nullable" : false, "enumKey" : "" },
                { "type" : "String", "name" : "品牌", "code" : "brand", "nullable" : false, "enumKey" : "" }
            ]
        }
    ],
    "extention_info" : {
          "list_config" : { },
          "add_config" : { },
          "common_read_config" : { },
          "common_edit_config" : { },
          "feature_read_config" : { },
          "feature_edit_config" : { },
          "readonly_tags_config" : [ ],
          "edit_tags_config" : [ ],
          "persist_config" : "com.dhcc.itsm.model.Device"
    }
}
失败 错误信息 {   success : false,   msg : xxx,   code : xxx }

异    常:

编号 描述

示例:

    $.ajax({
        url : '/cmdb/ci/category/definition/get.mvc',
        type : 'post',
        data : {
            id : 'xxxxx',
            code : 'test',
            type : 'json' 
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });
                

/cmdb/ci/category/definition/update.mvc

@RequestMapping(value="definition/update")
@ResponseBody
public java.lang.String updateDefinition(java.lang.String categoryId, java.lang.String modelDef)

参     数:

参数名 类型 描述 是否必须
categoryId String 类别id
modelDef String 模型定义json字符串

返 回 值:

  描述 范例
成功 成功信息 {  success : true  }
失败 错误信息 {   success : false,   msg : xxx,   code : xxx }

异    常:

编号 描述

示     例:

    $.ajax({
        url : '/cmdb/ci/category/definition/update.mvc',
        type : 'post',
        data : {
            'categoryId' : 'xxx' ,
            'modelDef' : '{aa : "a",bb : "b"}'
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });
            

/cmdb/ci/category/lifecycle/get.mvc

@RequestMapping(value="lifecycle/get")
@ResponseBody
public java.lang.String getLifecycle(java.lang.String id, java.lang.String code)

参     数:

参数名 类型 描述 是否必须
id String 类别id 与code必须存在一个,同时存在时以id作为查询条件
code String 类别编码 与id必须存在一个,同时存在时以id作为查询条件

返 回 值:

  描述 范例
成功 返回生命周期定义 {
    "id" : "402881d6483f64c601483f64e31b0002",
    "code" : "cagt_1_device",
    "status" : [
        {id:'', name : '', code:'', icon:''},
        {id:'', name : '', code:'', icon:''},
        {id:'', name : '', code:'', icon:''},
    ],
    "actions " : [
        { name : '', code:'',from : 'status' , to : 'status2' , handle:''},
        { name : '', code:'',from : 'status' , to : 'status2' , handle:''},
        { name : '', code:'',from : 'status' , to : 'status2' , handle:''},
    ],
    "extention_Info" : { graph_info:[ { status : 'xxx', x : '', y: ''} // 状态位置坐标 ]},
}
失败 错误信息 {   success : false,   msg : xxx,   code : xxx }

异    常:

编号 描述

示例:

    $.ajax({
        url : '/cmdb/ci/category/lifecycle/get.mvc',
        type : 'post',
        data : {
            id : 'xxxxx',
            code : 'xxxx',
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });
                

/cmdb/ci/category/lifecycle/update.mvc

@RequestMapping(value="lifecycle/update")
@ResponseBody
public java.lang.String updateLifecycle(java.lang.String categoryId, java.lang.String lifecycleDef)

参     数:

参数名 类型 描述 是否必须
categoryId String 类别id
lifecycleDef String 类别生命周期定义(参考生命周期定义文件说明)

返 回 值:

  描述 范例
成功 成功信息 {  success : true  }
失败 错误信息 {   success : false,   msg : xxx,   code : xxx }

异    常:

编号 描述

示     例:

    $.ajax({
        url : '/cmdb/ci/category/lifecycle/update.mvc',
        type : 'post',
        data : {
            'categoryId' : 'xxx' ,
            'modelDef' : '{id : "xxx",code : "xxx", …}'
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });
            

/cmdb/ci/status/create.mvc

@RequestMapping(value="create")
@ResponseBody
public java.lang.String create(CiStatus  status) throws com.otu.core.util.serialize.json.JSONException

参     数:

参数名 类型 描述
code String 状态code
name String 状态名称
description String 描述信息
icon String 图标
removable boolean 是否允许删除

返 回 值:

  描述 范例
成功 明细信息 {
  success : true,
  total : xxx,
  root :[  {  id : xxx,  name : xxx,  description : xxx  }  ]
}
失败 错误信息 {   success : false,   msg : xxx,   code : xxx   }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据序列化异常

示例:

    $.ajax({
        url : "/cmdb/ci/status/create.mvc",
        type : "post",
        data : {
            name:"测试"
        },
        dataType : "json",
        success : function(data) {
              alert(data);
        }
    });
                

/cmdb/ci/status/update.mvc

@RequestMapping(value="update")
@ResponseBody
public java.lang.String update( CiStatus  status)
                        throws com.otu.core.util.serialize.json.JSONException

参     数:

参数名 类型 描述
id String 状态id
code String 状态code
name String 状态名称
description String 描述信息
icon String 图标
removable boolean 是否允许删除

返 回 值:

  描述 范例
成功 明细信息 {
  success : true,
  total : xxx,
  root :[  {  id : xxx,  name : xxx,  description : xxx  }  ]
}
失败 错误信息 {   success : false,   msg : xxx,   code : xxx   }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据序列化异常

示例:

    $.ajax({
        url : "/cmdb/ci/status/update.mvc",
        type : "post",
        data : {
            name:"测试",
            code:"xxx",
            id:"xxx"
        },
        dataType : "json",
        success : function(data) { 
            alert(data);
        }
    });
                

/cmdb/ci/status/get.mvc

获取配置项状态信息,例如:指仅返回ID NAME CODE。

@RequestMapping(value="get")
@ResponseBody
public String get(String id) throws JSONException

 

参     数:

参数名 类型 描述 是否必须
id String 配置项状态的id

返 回 值:

  描述 范例
成功 得到类别状态 {
    success : true,  
     root :{   id: xxx,   name : xxx,   icon : xxx   }
失败 错误信息 {   success : false,   msg : xxx,   code : xxx   }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据序列化异常

示例:

    $.ajax({
        url : "/cmdb/ci/status/get.mvc",
        type : "post",
        data : {
            id: "402881d6483f64c601483f64e31b0000"
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });
                

/cmdb/ci/status/list.mvc

指定一个CI类别,获取此类别的状态定义,使用者可以指定返回的类别中包含的信息,例如:指仅返回ID NAME CODE。

@RequestMapping(value="list")
@ResponseBody
public String list(Map<String, Object> props, String categoryId, String[] attrs) throws JSONException

 

参     数:

参数名 类型 描述 是否必须
props Map<String, Object> 状态属性列表
categoryId String 配置项类别id, 为空时返回所有已知的状态,不为空时返回相应类别的全部状态。
attrs String[] 需要返回的属性名称,不指定attrs表示返回全部属性。 attrs 的可选范围:
  • id
  • name
  • code
  • description
  • icon
  • removable
  • updatedBy
  • updatedOn
  • createdBy
  • createdOn
多个可选值用逗号分隔,如:name,code,description,icon

返 回 值:

  描述 范例
成功 得到类别状态 {
    success : true,  
     total : xxx,  
     root :[
       {   id: xxx,   name : xxx,   icon : xxx   },
       {  ……  }
     ]
}
失败 错误信息 {   success : false,   msg : xxx,   code : xxx   }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据序列化异常

示例:

    $.ajax({
        url : "/cmdb/ci/status/list.mvc",
        type : "post",
        data : {
            categoryId: "402881d6483f64c601483f64e31b0000"
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });
                

/cmdb/ci/status/delete.mvc

传递状态定义ID,删除此状态。接口返回信息包括: 是否删除成功

删除指定的状态,当状态被使用时,不能删除(删除失败)

@RequestMapping(value="delete")
@ResponseBody
public java.lang.String delete(String[] statusId)

参     数:

参数名 类型 描述 是否必须
statusId String[] 需要删除的状态id,支持数组删除多个

返 回 值:

  描述 范例
成功 删除成功 {  success : true   }
失败 删除失败 {   success : false   }

异    常:

编号 描述

示例:

    $.ajax({
        url : "/cmdb/ci/status/delete.mvc",
        type : "post",
        data : {
            statusId: ["xxx", "xxx"]
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });
                

/cmdb/ci/status/isExistCode.mvc

@RequestMapping(value="isExistCode")
@ResponseBody
public java.lang.String existCode(java.lang.String name,
                                                 java.lang.String exceptId)

参     数:

参数名 类型 描述 是否必须
name String 需要验证的名称
exceptId String 排除的status id

返 回 值:

  描述 范例
成功 存在信息 {  success :true,  exist : true|false  }
失败 错误信息 {  success : false,   msg : xxx,   code : xxx   }

异    常:

编号 描述

示例:

    $.ajax({
        url : "/cmdb/ci/status/isExistCode.mvc", 
        type : "post",
        data : { 
            code: "xxx", 
            exceptId : 'xxx'
        },
        dataType : "json", 
        success : function(data) { 
            alert(data);
        } 
    });
                

/cmdb/ci/status/isExistName.mvc

@RequestMapping(value="isExistName")
@ResponseBody
public java.lang.String existName(java.lang.String code,
                                                 java.lang.String exceptId)

参     数:

参数名 类型 描述 是否必须
code String 需要验证的编码
exceptId String 排除的status id

返 回 值:

  描述 范例
成功 存在信息 {  success :true,  exist : true|false  }
失败 错误信息 {  success : false,   msg : xxx,   code : xxx   }

异    常:

编号 描述

示例:

    $.ajax({
        url : "/cmdb/ci/status/isExistName.mvc", 
        type : "post",
        data : { 
            code: "xxx", 
            exceptId : 'xxx'
        },
        dataType : "json", 
        success : function(data) { 
            alert(data);
        } 
    });
                

/cmdb/ci/relationship/definition/create.mvc

使用者传递新类别下列信息:

  • name: 名称(必填)
  • code: 编码
  • description: 描述
  • lineStyle : 线型
  • forImpact : 是否用于归因分析
  • isGraphic : 是否需要图形展示
  • isComponent : 是否为组件关系
  • rules :关系应用规则
  • readonly : 是否只读
  • removable : 是否允许删除

接口返回信息包括: 是否创建成功、 新分类的明细信息 OR 异常代码

@RequestMapping(value="create")
@ResponseBody
public java.lang.String create(RelationshipDefinition  refDef) throws com.otu.core.util.serialize.json.JSONException

参     数:

参数名 类型 描述 是否必须
code String 关系编码
name String 关系名称

返 回 值:

  描述 范例
成功 明细信息 {
   success : true,
   total : xxx,
   root :[  {  id : xxx,  name : xxx,  description: xxx  }  ]
}
失败 错误信息 {  success : false,   msg : xxx,   code : xxx   }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据序列化异常

示例:

    $.ajax({
        url : "/cmdb/ci/relationship/definition/create.mvc",
        type : "post",
        data : {
            name:'测试',
            code : 'test'
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });
                

/cmdb/ci/relationship/definition/update.mvc

使用者传递新类别下列信息:

  • id: id
  • name: 名称(必填)
  • code: 编码
  • description: 描述
  • lineStyle : 线型
  • forImpact : 是否用于归因分析
  • isGraphic : 是否需要图形展示
  • isComponent : 是否为组件关系
  • rules :关系应用规则
  • readonly : 是否只读

接口返回信息包括: 是否创建成功、 新分类的明细信息 OR 异常代码

@RequestMapping(value="update") @ResponseBody public java.lang.String update( RelationshipDefinition  refDef) throws com.otu.core.util.serialize.json.JSONException

参     数:

参数名 类型 描述 是否必须
id String 关系id
code String 关系code
name String 关系名称

返 回 值:

  描述 范例
成功 明细信息 {
   success : true,
   total : xxx,
   root :[  {  id : xxx,  name : xxx,  description: xxx  }  ]
}
失败 错误信息 {  success : false,   msg : xxx,   code : xxx   }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据序列化异常

示例:

    $.ajax({
        url : "/cmdb/ci/relationship/definition/update.mvc",
        type : "post",
        data : {
            name:"测试"
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });
                

/cmdb/ci/relationship/definition/get.mvc

@RequestMapping(value="getById")
@ResponseBody
public java.lang.String getById(java.lang.String id, java.lang.String attrs) throws com.otu.core.util.serialize.json.JSONException

参     数:

参数名 类型 描述 是否必须
id String 关系定义id
attrs String 需要返回的属性名称,不指定attrs表示返回全部属性。 attrs 的可选范围:
  • id
  • name
  • code
  • description
  • lineStyle
  • forImpact
  • isGraphic
  • isComponent
  • rules
  • readonly
  • updatedBy
  • updatedOn
  • createdBy
  • createdOn
多个可选值用逗号分隔,如:name,code,description

返 回 值:

  描述 范例
成功 关系明细信息 {
   success : true,
   total : xxx,
   root :[  {  id : xxx,  name : xxx,  description: xxx  }  ]
}
失败 错误信息 {  success : false,   msg : xxx,   code : xxx   }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据序列化异常

示例:

    $.ajax({
        url : "/cmdb/ci/relationship/definition/get.mvc",
        type : "post",
        data : {
            id: "xxx"
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });
                

/cmdb/ci/relationship/definition/list.mvc

@RequestMapping(value="list")
@ResponseBody
public java.lang.String list(java.lang.String attrs) throws com.otu.core.util.serialize.json.JSONException

参     数:

参数名 类型 描述 是否必须
attrs String 需要返回的属性名称,不指定attrs表示返回全部属性。 attrs 的可选范围:
  • id
  • name
  • code
  • description
  • lineStyle
  • forImpact
  • isGraphic
  • isComponent
  • rules
  • readonly
  • updatedBy
  • updatedOn
  • createdBy
  • createdOn
多个可选值用逗号分隔,如:name,code,description

返 回 值:

  描述 范例
成功 关系列表 {
  success : true,  
  total : xxx,  
  root :[   { id: xxx,  name : xxx,  description: xxx }  ]
}
失败 错误信息 {  success : false,   msg : xxx,   code : xxx   }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据序列化异常

示例:

    $.ajax({
        url : "/cmdb/ci/relationship/definition/list.mvc", 
        type : "post",
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });
    
    $.ajax({
        url : "/cmdb/ci/relationship/definition/list.mvc", 
        type : "post",
        data : {
            attrs : ['xxx','xxxxx','xxxxxx'...]
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });
                

/cmdb/ci/relationship/definition/delete.mvc

删除关系定义,如果关系定义被使用则删除失败

@RequestMapping(value="delete")
@ResponseBody
public String delete(String[] relationDefId)

参     数:

参数名 类型 描述 是否必须
relationDefId String[] 关系定义id数组

返 回 值:

  描述 范例
成功 删除成功 {  success : true   }
失败 删除失败 {  success : false   }

异    常:

编号 描述

示例:

    $.ajax({
        url : "/cmdb/ci/relationship/definition/delete.mvc",
        type : "post",
        data : {
            relationDefId: ["xxx", "xxx"]
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });
                

/cmdb/ci/relationship/definition/isExistCode.mvc

传递一个CODE字符串,返回这个CODE字符串已存在

@RequestMapping(value="isExistCode")
@ResponseBody
public java.lang.String exist(java.lang.String code, java.lang.String exceptId)

参     数:

参数名 类型 描述 是否必须
code String 待判定的code
exceptId String 需要排除的id

返 回 值:

  描述 范例
成功 存在信息 {  success : true,   exist : true|false   }
失败 错误信息 {  success : false,   msg : xxx,   code : xxx   }

异    常:

编号 描述

示例:

    $.ajax({
        url : "/cmdb/ci/relationship/definition/isExistCode.mvc",
        type : "post",
        data : {
            code: "xxx"
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });
                

/cmdb/ci/create.mvc

@RequestMapping(value="create")
@ResponseBody
public java.lang.String create(java.lang.String categoryId,
                                                  @RequestParam
                                                  java.util.Map<java.lang.String,java.lang.Object> props)
                        throws com.otu.core.util.serialize.json.JSONException

参     数:

参数名 类型 描述 是否必须
categoryId String 配置项类别id
apApplicationLevel String 应用层级
apPorts String 端口结构
…… …… props更多查阅可扩展属性列表

返 回 值:

  描述 范例
成功 配置项的明细信息 {
   success : true,  
   root :{  id : xxx,  name :xxx,  category: xxx  ......  }
}
失败 错误信息 {   success : false,    msg : xxx,    code : xxx    }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据序列化异常

示例:

    $.ajax({
        url : '/cmdb/ci/create.mvc',
        data : {
            'categoryId' : 'xxx',
            'name' : 'xxx',
            'assertNO' : 'xxx',
            'status.id' : 'xxx'
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });
                

/cmdb/ci/update.mvc

@RequestMapping(value="update")
@ResponseBody
public java.lang.String update(java.lang.String id,
                                                  @RequestParam
                                                  java.util.Map<java.lang.String,java.lang.Object> props)
                        throws com.otu.core.util.serialize.json.JSONException

参     数:

参数名 类型 描述 是否必须
id String 需要更新的配置项id,不能为空
apApplicationLevel String 应用层级
apPorts String 端口结构
…… …… props更多查阅可扩展属性列表

返 回 值:

  描述 范例
成功 配置项的明细信息 {
   success : true,  
   root :{  id : xxx,  name :xxx,  category: xxx  ......  }
}
失败 错误信息 {   success : false,    msg : xxx,    code : xxx    }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据序列化异常

示例:

    $.ajax({ 
        url : '/cmdb/ci/update.mvc', 
        data : {
            'id' : 'xxx',
            'name' : 'xxx'
        },
        dataType : "json",
        success : function(data) { 
            alert(data);
        }
    });
                

/cmdb/ci/get.mvc

@RequestMapping(value="get")
@ResponseBody public String get(String id, String[] attrs, boolean includeContainCi, boolean includeAncestorCtgId) throws JSONException

参     数:

参数名 类型 描述 是否必须
id String 配置项id,不允许为空
attrs String 需要返回的属性列表,
可用属性列表参考: SupportService.getCiCategory(String)的返回值相关内容
includeContainCi boolean 是否返回其包含的配置项信息(即具有包含关系),默认false
includeAncestorCtgId boolean 是否返回所属类别的顶级类别的id,默认false

返 回 值:

  描述 范例
成功 配置项的明细信息 {
   success : true,  
   root :{  id : xxx,  name :xxx,  category: xxx  ......  }
}
失败 错误信息 {  success : false,   msg : xxx,   code : xxx   }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据序列化异常

示例:

    $.ajax({
        url : '/cmdb/ci/get.mvc',
        data : {
            'id' : 'xxx', // 需要更新的配置项id
            'includeContainCi' : true, 
            'attrs' : 'name,category,status,impact,...' // 不包含此参数表示返回全部信息 
        }
    });
                

/cmdb/ci/list.mvc

此方式是一个对CMDB中CI进行查询的统一接口 (只能获取CI的通用信息)

使用者可以指定获取清单的条件:

  • 条件可以任意组合
  • 条件的KEY可以对应CI数据池表进行组装 (KEY只能为通用信息类的属性)

返回数据CI的清单集合:

  • 集合中每个CI都只包含通用信息属性
  • 并且使用者可以指定返回数据中CI的通用属性
  • 过滤掉不需要返回的属性
@RequestMapping(value="list")
@ResponseBody
public String list(@RequestParam Map<String, Object> props, String[] categoryIds, String[] attrs, boolean deepIn) throws JSONException

参     数:

参数名 类型 描述 是否必须
props Map<String, Object> 配置项属性列表
attrs String[] 需要显示的属性列表,为空时全部返回
categoryIds String[] 配置项类别id数组,为空时查询所有类别的配置项
deepIn boolean 是否级联获取子类别,与categoryIds配套使用
name String 名称
status.id String 状态ID
…… …… 查询参数列表,参数可添加后缀进行复杂匹配,props更多查阅 JAVA API 中CiGenericInfo的属性
说明:CMDB根据不同的后缀封装查询条件,后缀如下:
  • = : eq
  • > :gt
  • < :lt
  • >= :ge
  • <= : le
  • like :like
  • in :in
  • notIn :notIn
  • notLike :notLike
使用时将属性与后缀以*分割拼接即可,即 属性名称*后缀 : 'xxx',因此接口只返回通用信息,故匹配的属性必须在通用信息中国,还可参考下面的详细示例教程

返 回 值:

  描述 范例
成功 明细信息 {
  success : true,
  total : xxx,
  root :[  {  id : xxx,  name : xxx,  ......  }  ]
}
失败 错误信息 {   success : false,    msg : xxx,    code : xxx    }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据序列化异常

示例:

    $.ajax({
       url : "/cmdb/ci/list.mvc",
       type : "post",
       data : {
           'attrs' : ['name','category.name','category.id',...] // 不包含此参数表示返回全部信息
           'start' : 0,
           'limit' : 20,
           'sortName' : 'name',    //排序的属性
           'sortOrder' : 'desc'    //升序排序或降序排序,asc|desc,默认为asc(升序排序)
           
           //条件组合,和以上参数区别开来(此接口只返回通用信息,故匹配的属性只能为CiGenericInfo的属性,以下示例只做教程说明)
           'name' : 'xxx', // 查询name = xxx 的记录,没有后缀默认为eq
           'name*eq' : 'xxx', // 查询name =xxx 的记录,eq可省略
           'apPortCount*gt' : 'xxx', // 查询apPortCount > xxx 的记录,
           'apPortCount*lt' : 'xxx', // 查询apPortCount < xxx 的记录,
           'apPortCount*ge' : 'xxx', // 查询apPortCount >= xxx 的记录,
           'apPortCount*le' : 'xxx', // 查询apPortCount <= xxx 的记录,
           'apPortCount*like' : 'xxx',    //查询apPortCount like '%xxx%' 的记录, 后台自动封装%
           'apPortCount*notLike' : 'xxx', // 查询去除apPortCount like '%xxx%'的记录,后台自动封装%
           'id*in' : 'xx1,xx2', // 查询id 为'xx1'或'xx2'的记录, id以','分隔
           'id*notIn' : 'xx1,xx2', // 查询id 不为'xx1'和'xx2'的记录, id以','分隔
       },
       dataType : "json",
       success : function(data) {
           alert(data);
       }
    });
                

/cmdb/ci/listByCiCategory.mvc

指定类别的ID,获取此类别下所有CI的清单 (可获取CI的通用信息和特征信息)

  • 默认只获取此分类下的CI,不获取子类的CI
  • 使用者可以通过指定参数,获取所有子类的CI,以及指定层次子类的CI

返回数据CI的清单集合

  • 集合中每个CI都包含了所有属性 (通用信息 + 特征信息)
  • 并且使用者可以指定返回数据中CI的属性
  • 过滤掉不需要返回的属性
@RequestMapping(value="listByCiCategory")
@ResponseBody
public String listByCiCategory(@RequestParam Map<String, Object> props, String categoryId, String[] attrs, Boolean deepIn) throws JSONException

参     数:

参数名 类型 描述 是否必须
prop Map<String, Object> 配置项属性列表
categoryId String 类别id
attrs String[] 需要显示的属性列表
deepIn boolean 是否级联获取子类别,与categoryIds配套使用
apApplicationLevel String 应用层级
apPorts String 端口结构
…… …… 查询参数列表,参数可添加后缀进行复杂匹配,props更多查阅可扩展属性列表
说明:CMDB根据不同的后缀封装查询条件,后缀如下:
  • = : eq
  • > :gt
  • < :lt
  • >= :ge
  • <= : le
  • like :like
  • in :in
  • notIn :notIn
  • notLike :notLike
使用时将属性与后缀以*分割拼接即可,即 属性名称*后缀 : 'xxx',还可参考下面的详细示例教程

返 回 值:

  描述 范例
成功 明细信息 {
     success : true,
     root :{   id : xxx,   name :xxx,   ......  }
}
失败 错误信息 {  success : false,   msg : xxx,   code : xxx   }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据序列化异常

示例:

    $.ajax({ 
        url : "/cmdb/ci/listByCiCategory.mvc", 
        type : "post",
        data : { 
            categoryId : 'xxx',
            attrs : 'name,category,status,impact,...' , 
            deepIn : false, 
            start : 0, 
            limit : 20,
            
           //条件组合,和以上参数区别开来(具体的属性参考对应的类别属性和通用信息属性,以下示例只做教程说明)
           'name' : 'xxx', // 查询name = xxx 的记录,没有后缀默认为eq
           'name*eq' : 'xxx', // 查询name =xxx 的记录,eq可省略
           'apPortCount*gt' : 'xxx', // 查询apPortCount < xxx 的记录,
           'apPortCount*lt' : 'xxx', // 查询apPortCount > xxx 的记录,
           'apPortCount*ge' : 'xxx', // 查询apPortCount >= xxx 的记录,
           'apPortCount*le' : 'xxx', // 查询apPortCount <= xxx 的记录,
           'apPortCount*like' : 'xxx',    //查询apPortCount like '%xxx%' 的记录, 后台自动封装%
           'apPortCount*notLike' : 'xxx', // 查询去除apPortCount like '%xxx%'的记录,后台自动封装%
           'id*in' : 'xx1,xx2', // 查询id 为'xx1'或'xx2'的记录, id以','分隔
           'id*notIn' : 'xx1,xx2', // 查询id 不为'xx1'和'xx2'的记录, id以','分隔
        }, 
        dataType : "json", 
        success : function(data) { 
            alert(data);
        } 
    });
                

/cmdb/ci/listByCiCategorys.mvc

指定某些类别的配置项通用信息和特征信息列表,获取这些类别下所有CI的清单 (可获取CI的通用信息和特征信息)

  • 默认只获取此分类下的CI,不获取子类的CI
  • 使用者可以通过指定参数,获取所有子类的CI,以及指定层次子类的CI

返回数据CI的清单集合

  • 集合中每个CI都包含了所有属性 (通用信息 + 特征信息)
  • 并且使用者可以指定返回数据中CI的属性
  • 过滤掉不需要返回的属性
@RequestMapping(value="listByCiCategorys")
@ResponseBody
public String listByCiCategorys(@RequestParam Map<String, Object> props, String[] categoryIds, String[] attrs, Boolean deepIn) throws JSONException

参     数:

参数名 类型 描述 是否必须
prop Map<String, Object> 配置项属性列表
categoryIds String[] 配置项类别id数组,必须满足的条件:所有的类别id的顶级父类(即一级类别)必须相同
attrs String[] 需要显示的属性列表
deepIn boolean 是否级联获取子类别,与categoryIds配套使用
apApplicationLevel String 应用层级
apPorts String 端口结构
…… …… 查询参数列表,参数可添加后缀进行复杂匹配,props更多查阅可扩展属性列表
说明:CMDB根据不同的后缀封装查询条件,后缀如下:
  • = : eq
  • > :gt
  • < :lt
  • >= :ge
  • <= : le
  • like :like
  • in :in
  • notIn :notIn
  • notLike :notLike
使用时将属性与后缀以*分割拼接即可,即 属性名称*后缀 : 'xxx',还可参考下面的详细示例教程

返 回 值:

  描述 范例
成功 明细信息 {
     success : true,
     root :{   id : xxx,   name :xxx,   ......  }
}
失败 错误信息 {  success : false,   msg : xxx,   code : xxx   }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据序列化异常

示例:

    $.ajax({ 
        url : "/cmdb/ci/listByCiCategorys.mvc", 
        type : "post",
        data : { 
            categoryIds : ['xxx', 'xxx'],
            attrs : 'name,category,status,impact,...' , 
            deepIn : false, 
            start : 0, 
            limit : 20,
            
           //条件组合,和以上参数区别开来(具体的属性参考对应的类别属性和通用信息属性,以下示例只做教程说明)
           'name' : 'xxx', // 查询name = xxx 的记录,没有后缀默认为eq
           'name*eq' : 'xxx', // 查询name =xxx 的记录,eq可省略
           'apPortCount*gt' : 'xxx', // 查询apPortCount < xxx 的记录,
           'apPortCount*lt' : 'xxx', // 查询apPortCount > xxx 的记录,
           'apPortCount*ge' : 'xxx', // 查询apPortCount >= xxx 的记录,
           'apPortCount*le' : 'xxx', // 查询apPortCount <= xxx 的记录,
           'apPortCount*like' : 'xxx',    //查询apPortCount like '%xxx%' 的记录, 后台自动封装%
           'apPortCount*notLike' : 'xxx', // 查询去除apPortCount like '%xxx%'的记录,后台自动封装%
           'id*in' : 'xx1,xx2', // 查询id 为'xx1'或'xx2'的记录, id以','分隔
           'id*notIn' : 'xx1,xx2', // 查询id 不为'xx1'和'xx2'的记录, id以','分隔
        }, 
        dataType : "json", 
        success : function(data) { 
            alert(data);
        } 
    });
                

/cmdb/ci/statisticsByCiCategorys.mvc

根据多类别、多条件统计查询配置项列表 (可获取CI的通用信息和特征信息)

  • 只获取指定条件下的CI,不获取子类的CI

返回数据CI的清单集合

  • 集合中每个CI都包含了所有属性 (通用信息 + 特征信息)
  • 并且使用者可以指定返回数据中CI的属性
  • 过滤掉不需要返回的属性
@RequestMapping(value="statisticsByCiCategorys")
@ResponseBody
public String statisticsByCiCategorys(String searchProps, String defaultCategoryId, boolean existEmptyResult, String[] attrs) throws JSONException

参     数:

参数名 类型 描述 是否必须
searchProps String 查询参数列表,添加后缀支持复杂查询,属性和后缀以*分割,后缀参考 {@link QueryConditions};格式如下: *[{"categoryId":"402881d6483f64c601483f64e31b0002" ,"assetNO*like":"Device0000000001"},...] (与defaultCategoryId任选其一)
categoryIds String[] 默认的类别Id,当searchProps为空时,根据此类别id查询 (与searchProps任选其一)
existEmptyResult boolean 是否允许某一类别的查询结果为空,如果为false,根据多个类别查询的结果中存在为空的类别时返回数据为空 默认为false
attrs String[] 需要显示的属性列表
apApplicationLevel String 应用层级
apPorts String 端口结构
…… …… 查询参数列表,参数可添加后缀进行复杂匹配,props更多查阅可扩展属性列表
说明:CMDB根据不同的后缀封装查询条件,后缀如下:
  • = : eq
  • > :gt
  • < :lt
  • >= :ge
  • <= : le
  • like :like
  • in :in
  • notIn :notIn
  • notLike :notLike
使用时将属性与后缀以*分割拼接即可,即 属性名称*后缀 : 'xxx',还可参考下面的详细示例教程

返 回 值:

  描述 范例
成功 明细信息 {
     success : true,
     root :{   id : xxx,   name :xxx,   ......  }
}
失败 错误信息 {  success : false,   msg : xxx,   code : xxx   }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据序列化异常

示例:

    $.ajax({ 
        url : "/cmdb/ci/statisticsByCiCategorys.mvc", 
        type : "post",
        data : { 
            searchProps : [{"categoryId":"402881d6483f64c601483f64e31b0002","assetNO*like":"Device0000000001"},...],
            attrs : 'name,category,status,impact,...' , 
            deepIn : false, 
            start : 0, 
            limit : 20
        }, 
        dataType : "json", 
        success : function(data) { 
            alert(data);
        } 
    });
                

/cmdb/ci/search.mvc

@RequestMapping(value="search")
@ResponseBody
public String search(String categoryId, String key, Integer start, Integer limit) throws JSONException

参     数:

参数名 类型 描述 是否必须
categoryId String 类别id
key String 用户输入的查询条件 否,为空时返回所有数据,多个key以一个空格隔开
start int 开始索引 否,默认0
limit int 页大小 否,默认为int类型最大值

返 回 值:

  描述 范例
成功 配置项的明细信息 {
  success : true,
  total : xxx,
  root :[  {  id : xxx,  name : xxx,  ......  }  ]
}
失败 错误信息 {   success : false,    msg : xxx,    code : xxx    }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据序列化异常

示例:

    $.ajax({ 
        url : '/cmdb/ci/search.mvc', 
        data : {
            'categoryId' : 'xxx',
            'key' : 'x1 xx2 xx3'
        },
        dataType : "json",
        success : function(data) { 
            alert(data);
        }
    });
                

/cmdb/ci/delete.mvc

@RequestMapping(value="delete")
@ResponseBody
public String delete(String[] id)

参     数:

参数名 类型 描述 是否必须
id String[] 需要删除的配置项id数组,不能为空

返 回 值:

  描述 范例
成功 删除成功 {  success : true   }
失败 删除失败 {  success : false    }

异    常:

编号 描述

示例:

    $.ajax({
        url : '/cmdb/ci/delete.mvc',
        data : {
            'id' : ['xxx','xxx']
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });
                

/cmdb/ci/isExistCiAssetNO.mvc

@RequestMapping(value="isExistCiAssetNO")
@ResponseBody
public java.lang.String isExistCiAssetNO(java.lang.String assetNO, java.lang.String exceptId)

参     数:

参数名 类型 描述 是否必须
assetNO String 需要被判断字符串
exceptId String 需要排除的类别id

返 回 值:

  描述 范例
成功 显示是否存在 {   success : true,   exist : true|false   }
失败 失败信息 {   success : false,   msg : xxx,   code : xxx   }

异    常:

编号 描述

示例:

    $.ajax({
        url : "/cmdb/ci/isExistCiAssetNO.mvc",
        type : "post",
        data : {
            assetNO: "xxx",
            exceptId : 'xxx'
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });
                

/cmdb/ci/getCiAssetNO.mvc

@RequestMapping(value="getCiAssetNO")
@ResponseBody
public java.lang.String getCiAssetNO(java.lang.String categoryId, java.lang.String rule, java.lang.String length, java.lang.String step)

参     数:

参数名 类型 描述 是否必须
categoryId String 类别id
rule String 编号生成规则
length String 流水号长度
rule String 编号生成规则
step String step 步长

返 回 值:

  描述 范例
成功 显示是否存在 {   code : xxxx   }
失败 失败信息

异    常:

编号 描述

示例:

    $.ajax({
        url : "/cmdb/ci/getCiAssetNO.mvc",
        type : "post",
        data : {
            categoryId: "xxx",
            rule : "{constant}{NO}",
            length : 10,
            step : 1
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });
                

/cmdb/ci/countForCiCategory.mvc

@RequestMapping(value="countForCiCategory")
@ResponseBody
public java.lang.String countForCiCategory()

返 回 值:

  描述 范例
成功 各类别下Ci数量 {
  success : true,
  root : [
      {  key : { id : 'xxx',name : 'category1'},  value : 100  },
      {  key : { id : 'xxx',name : 'category2'},  value : 100  },
      {  key : { id : 'xxx',name : 'category3'},  value : 100  },
      ...
   ]
}
失败 错误信息 {   success : false,   msg : xxx,   code : xxx   }

异    常:

编号 描述

示例:

    $.ajax({
        url : '/cmdb/ci/countForCiCategory.mvc',
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });
                

/cmdb/ci/getCountByCiCategory.mvc

指定类别的ID,获取此类别下所有CI的总数

使用者可以通过指定参数:

         获取所有子类的CI总数,

         以及指定层次子类的CI总数。

默认只获取此分类下的CI,不获取子类的CI;

@RequestMapping(value="getCountByCiCategory")
@ResponseBody
public java.lang.String getCountByCiCategory(java.lang.String categoryId,
                                                                java.lang.Boolean deepIn)

参     数:

参数名 类型 描述 是否必须
categoryId Strin 类别id,不允许为空
deepIn Boolean 是否级联统计子类别数量(暂时无效)

返 回 值:

  描述 范例
成功 各类别下Ci数量 {   success : true,   count : 100   }
失败 错误信息 {   success : false,   msg : xxx,   code : xxx   }

示例:

    $.ajax({
        url : '/cmdb/ci/getCountByCiCategory.mvc', 
        data : { 
            'id' : 'xxx', 
            'deepIn':false
        },
        dataType : "json", 
        success : function(data) {
            alert(data);
        }
    });
                

/cmdb/ci/countForCiStatus.mvc

@RequestMapping(value="countForCiStatus")
@ResponseBody
public java.lang.String countForCiStatus()

返 回 值:

  描述 范例
成功 各状态下Ci数量 {
  success : true,
  root : [
      {   key : { id : 'xxx',name : 'status1'},  value : 100  },
      {   key : { id : 'xxx',name : 'status2'},  value : 100  },
      {   key : { id : 'xxx',name : 'status3'},  value : 100  },
      ...
  ]
}
失败 错误信息 {   success : false,   msg : xxx,   code : xxx   }

异    常:

编号 描述

示例:

    $.ajax({
    url : '/cmdb/ci/countForCiStatus.mvc',
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });
                

/cmdb/ci/countByCiStatus.mvc

@RequestMapping(value="getCountByCiStatus")
@ResponseBody
public java.lang.String getCountByCiStatus(java.lang.String statusId)

参     数:

参数名 类型 描述 是否必须
statusId String 状态id,不允许为空

返 回 值:

  描述 范例
成功 各状态下Ci数量 {   success : true,   count : 100,   }
失败 错误信息 {   success : false,   msg : xxx,   code : xxx   }

示例:

    $.ajax({ 
        url : '/cmdb/ci/getCountByCiStatus.mvc', 
        data : { 
            'statusId' : 'xxx'
        }, 
        dataType : "json", 
        success : function(data) { 
            alert(data);
        }
    });
                

/cmdb/file/exportData.mvc

导出数据存储在excel文件中,默认名称为CiData.xlsx

@RequestMapping(value="exportData")
@ResponseBody
public String exportData(HttpServletResponse response, String filter, String categoryId, boolean deepIn)

参     数:

参数名 类型 描述 是否必须
filter String 类别过滤器。
导出指定类别数据传递类别 id,
导出多个类别数据用逗号分隔,如"idxxx, id2xxx"
使用此参数不级联导出其子类别的数据。
与categoryId选一即可,同时为null导出全部数据,同时存在以filter为主,
categoryId String 导出指定类别的配置项数据,
配合deepIn参数可选择是否级联导出其子类的配置项数据
与filter选一即可,同时为null导出全部数据,同时存在以filter为主
deepIn boolean 与categoryId配合使用,指定是否级联导出子类别的数据,默认为false

返 回 值:

  描述 范例

异    常:

编号 描述
IOException 输入输出流异常

示例:

$.ajax({
    url : '/cmdb/file/exportData.mvc',
    data : {
        'filter' : 'xxid1,xxxid2'
        //or
        'categoryId' : 'id1',
        'deepIn' : true
     }
});

/cmdb/file/exportDataByCondition.mvc

根据条件导出部分数据存储在excel文件中,默认名称为CiData.xlsx

@RequestMapping(value="exportDataByCondition")
@ResponseBody
public String exportDataByCondition(HttpServletResponse response, String ciFilter)

参     数:

参数名 类型 描述 是否必须
ciFilter String 导出数据匹配过滤器说明。
导出指定的id的配置项记录,
导出多个类别数据用逗号分隔,如"idxxx, id2xxx"

返 回 值:

  描述 范例

异    常:

编号 描述
IOException 输入输出流异常

示例:

$.ajax({
    url : '/cmdb/file/exportDataByCondition.mvc',
    data : {
        'ciFilter' : 'xxid1,xxxid2'
     }
});

/cmdb/file/downloadTemplate.mvc

下载配置项模板,默认名称为CiTemplate.xlsx

@RequestMapping(value="downloadTemplate")
@ResponseBody
public void downloadTemplate(HttpServletResponse response, String filter)

参     数:

参数名 类型 描述 是否必须
filter String 导出指定类别的配置项模板,传递类别id,多个类别用逗号分隔,如 "idxxx, id2xxx",

返 回 值:

  描述 范例

异    常:

编号 描述
IOException 输入输出流异常

示例:

$.ajax({
    url : '/cmdb/file/exportData.mvc',
    data : {
        'filter' : 'xxid1,xxxid2'
     }
});

/cmdb/file/import.mvc

@RequestMapping(value="import")
@ResponseBody
public String importCiData(MultipartFile file) throws IOException

参     数:

参数名 类型 描述 是否必须
file MultipartFile 源数据文件

返 回 值:

  描述 范例
成功 导入成功 { success : true }

异    常:

编号 描述
IOException 输入输出流异常

示例:

$.ajax({
    url : '/cmdb/file/import.mvc',
    data : {
        'file' : ''
    },
    success : function(data) {
            alert(data);
    }
});

/cmdb/file/checkImportDataFile.mvc

判断导入数据是否正确

@RequestMapping(value="checkImportDataFile")
@ResponseBody
public String checkImportDataFile(final MultipartFile componentUpload) throws IOException

参     数:

参数名 类型 描述 是否必须
componentUpload MultipartFile 源数据文件

返 回 值:

  描述 范例
成功 检查成功 { success : true|false, count : xx, root : [], failInfo : [] }
失败 检查失败 { success : false }

异    常:

编号 描述
IOException 输入输出流异常

示例:

$.ajax({
    url : '/cmdb/file/checkImportDataFile.mvc',
    data : {
        'componentUpload' : ''
    },
    success : function(data) {
            alert(data);
    }
});

/cmdb/file/previewTemplate.mvc

@RequestMapping(value="previewTemplate")
@ResponseBody
public String previewTemplate(HttpServletResponse response, String fileType, String categoryId) throws IOException

参     数:

参数名 类型 描述 是否必须
fileType String 文件类型
categoryId String 类别id

返 回 值:

  描述 范例
成功 成功 { success : true, url : '' }

异    常:

编号 描述
IOException 输入输出流异常

示例:

$.ajax({
    url : '/cmdb/file/previewTemplate.mvc',
    data : {
        'fileType' : '',
        'categoryId' : ''
    },
    success : function(data) {
            alert(data);
    }
});

/cmdb/ci/resource/uploadIcon.mvc

@RequestMapping(value="uploadIcon")
@ResponseBody
public java.lang.String uploadIcon(final MultipartFile imageUpload, String filename) throws Exception

参     数:

参数名 类型 描述 是否必须
imageUpload MultipartFile 上传的图片文件
filename String 存储的文件夹名称

返 回 值:

  描述 范例
成功 配置项的明细信息 {
   success : true,  
}
失败 错误信息 {   success : false,    msg : xxx,    code : xxx    }

异    常:

编号 描述
java.lang.Exception 异常

示例:

    $.ajax({ 
        url : '/cmdb/ci/resource/uploadIcon.mvc', 
        data : {
            'filename' : 'xxx'
        },
        dataType : "json",
        success : function(data) { 
            alert(data);
        }
    });
                

/cmdb/ci/resource/removeIcon.mvc

@RequestMapping(value="removeIcon")
@ResponseBody
public java.lang.String removeIcon(String deleteName) throws Exception

参     数:

参数名 类型 描述 是否必须
deleteName String 删除的文件夹名称

返 回 值:

  描述 范例
成功 配置项的明细信息 {
   success : true,  
}
失败 错误信息 {   success : false,    msg : xxx,    code : xxx    }

异    常:

编号 描述
java.lang.Exception 异常

示例:

    $.ajax({ 
        url : '/cmdb/ci/resource/removeIcon.mvc', 
        data : {
            'deleteName' : 'xxx'
        },
        dataType : "json",
        success : function(data) { 
            alert(data);
        }
    });
                

/cmdb/ci/resource/listIcon.mvc

@RequestMapping(value="listIcon")
@ResponseBody
public java.lang.String listIcon(String filename) throws Exception

参     数:

参数名 类型 描述 是否必须
filename String 存储的文件夹名称

返 回 值:

  描述 范例
成功 配置项的明细信息 {
   success : true,  
}
失败 错误信息 {   success : false,    msg : xxx,    code : xxx    }

异    常:

编号 描述
java.lang.Exception 异常

示例:

    $.ajax({ 
        url : '/cmdb/ci/resource/listIcon.mvc', 
        data : {
            'filename' : 'xxx'
        },
        dataType : "json",
        success : function(data) { 
            alert(data);
        }
    });
                

/cmdb/ci/relationship/create.mvc

@RequestMapping(value="create")
@ResponseBody
public String create(Relationship relation) throws JSONException

参     数:

参数名 类型 描述 是否必须
source.id String 关系开始的配置项id
target.id String 关系结束端配置项id
definition.id String 关系定义id
remarks String 备注
sourcePoint.id String 起点设备端口
targetPoint.id String 终点设备端口
name String 关系别名

返 回 值:

  描述 范例
成功 明细信息 {
   success : true,
   total : xxx,
   root :{  id : xxx,  from: xxx,  to: xxx,   ......  }
}
失败 错误信息 {  success : false,   msg : xxx,   code : xxx   }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据序列化异常

示例:

    $.ajax({
        url : "/cmdb/ci/relationship/create.mvc",
        type : "post",
        data : {
            'name' : 'xxx',
            'source.id' : 'xxxx',
            'target.id' : 'xxxx',
            'definition.id' : 'xxxx',
            'remarks' : 'xxx',
            'sourcePoint.id' : 'xxxx',
            'targetPoint.id' : 'xxxx'
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });

/cmdb/ci/relationship/batchCreate.mvc

批量创建关系

@RequestMapping(value="batchCreate")
@ResponseBody
public String batchCreate(Relationship[] relations) throws JSONException

参     数:

参数名 类型 描述 是否必须
relations Relationship[] Relationship集合

返 回 值:

  描述 范例
成功 明细信息 {
   success : true,
   total : xxx,
   root :{  id : xxx,  from: xxx,  to: xxx,   ......  }
}
失败 错误信息 {  success : false,   msg : xxx,   code : xxx   }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据序列化异常

示例:

    $.ajax({
        url : "/cmdb/ci/relationship/batchCreate.mvc",
        type : "post",
        data : {
            relations : ['xxx1', 'xxx2']
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });

/cmdb/ci/relationship/update.mvc

只能更新关系的类型和备注

@RequestMapping(value="update")
@ResponseBody
public java.lang.String update(java.lang.String id,
            java.lang.String defId, java.lang.String remarks) throws com.otu.core.util.serialize.json.JSONException
         

参     数:

参数名 类型 描述 是否必须
id String 关联关系id, 不可为空
defId String 关系定义id ,参数为空时表示不更新相应的内容
remarks String 备注信息 ,参数为空时表示不更新相应的内容

返 回 值:

  描述 范例
成功 明细信息 {
  success : true,
  total : xxx,
  root :{  id : xxx,  from: xxx,  to: xxx,  ......  }
}
失败 错误信息 {  success : false,   msg : xxx,   code : xxx   }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据序列化异常

示例:

    $.ajax({
        url : "/cmdb/ci/relationship/update.mvc",
        type : "post",
        data : {
            id:'xxx',
            defId:'xxxx',
            remarks:'xxx'
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });
                

/cmdb/ci/relationship/listRelationsForCi.mvc

@RequestMapping("listRelationsForCi")
@ResponseBody
public String listRelationsForCi(String ciId, String[] relationDefIds, String categoryId, boolean deepIn) throws JSONException

参     数:

参数名 类型 描述 是否必须
ciId String 指定ci的id
relationDefIds String[] 指定关系类型,为空表示获取全部类型的关系
categoryId String 指定ci的类别,为null匹配所有类别的ci
deepIn boolean 是否级联查询获取子类别,默认为false

返 回 值:

  描述 范例
成功 明细信息 {
  success : true,
  total : xxx,
  root :[  {  id : xxx,  from: xxx,  ......  }  ]
}
失败 错误信息 {  success : false,   msg : xxx,   code : xxx   }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据序列化异常

示例:

    $.ajax({
        url : "/cmdb/ci/relationship/listRelationsForCi.mvc",
        type : "post",
        data : {
            ciId: 'xxx',
            relationDefIds : ['rr1','rr2'],
            categoryId : 'cc1',
            deepIn : false
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });

/cmdb/ci/relationship/delete.mvc

此接口有种调用方法,以前端传递的参数是否包含"refId"判断

//有refId参数时
@RequestMapping(value="delete", params="refId")
@ResponseBody
public String delete(String[] refId)

//没有refId参数时
@RequestMapping(value="delete", params="!refId")
@ResponseBody
public String delete( String[] sourceId, String[] targetId, String[] definitionId )

参     数:

参数名 类型 描述 是否必须
refId String[] 关系id数组
参数名 类型 描述 是否必须
sourceId String[] sourceId集合
targetId String[] targetId集合
definitionId String[] definitionId集合

注:指定需删除的关系记录的sourceId、targetId、definitionId,三者需同时存在,且数组长度相同,下标相同为一组参数,确定一条关系记录

返 回 值:

  描述 范例
成功 删除成功 {  success : true   }
失败 删除失败 {  success : false   }

示例:

    $.ajax({
        url : "/cmdb/ci/relationship/delete.mvc",
        type : "post",
        data : {
            refid:['xxx','xxx']
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });
    
    $.ajax({
        url : "/cmdb/ci/relationship/delete.mvc",
        type : "post",
        data : {
            sourceId : ['ss1','ss2'],
            targetId : ['tt1','tt2'],
            definitionId : ['dd1','dd2']
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });

/cmdb/ci/relationship/isRelationshipExist.mvc

@RequestMapping("isRelationshipExist")
@ResponseBody
public String exist(String sourceId, String targetId, String definitionId, String exceptId)

参     数:

参数名 类型 描述 是否必须
sourceId String 关系开始端的配置项id
targetId String 关系结束端配置项id
definitionId String 关系定义id
exceptId String 判断时排除某条关系id 否, 一般用于关系更新时排除自身

返 回 值:

  描述 范例
成功 存在与否信息 {success : true,exist : true | false}
失败 错误信息 {  success : false,   msg : xxx,   code : xxx   }

异    常:

编号 描述

示例:

    $.ajax({
        url : "/cmdb/ci/relationship/isRelationshipExist.mvc",
        type : "post",
        data : {
            sourceId :'xxxx',
            targetId :'xxxx',
            definitionId :'xxxx',
            exceptId :'xx'
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });

/cmdb/ci/relationship/isRelationshipNameExist.mvc

@RequestMapping("isRelationshipNameExist")
@ResponseBody
public String exist(String sourceId, String targetId, String name)

参     数:

参数名 类型 描述 是否必须
sourceId String 关系开始端的配置项id
targetId String 关系结束端配置项id
name String 关系的别名,通常用于端口之间的链路关系

返 回 值:

  描述 范例
成功 存在与否信息 {success : true,exist : true | false}
失败 错误信息 {  success : false,   msg : xxx,   code : xxx   }

异    常:

编号 描述

示例:

    $.ajax({
        url : "/cmdb/ci/relationship/isRelationshipNameExist.mvc",
        type : "post",
        data : {
            sourceId :'xxxx',
            targetId :'xxxx',
            name :'xxxx'
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });

/cmdb/ci/relationship/countCiRelative.mvc

@RequestMapping("countCiRelative")
@ResponseBody
public String countCiRelative(String ciId, String[] filters)

参     数:

参数名 类型 描述 是否必须
ciId String 配置项id
filters String[] 类别id集合

返 回 值:

  描述 范例
成功 成功信息 {success : true, root : []}
失败 错误信息 {  success : false   }

异    常:

编号 描述

示例:

    $.ajax({
        url : "/cmdb/ci/relationship/countCiRelative.mvc",
        type : "post",
        data : {
            ciId : 'xxxx',
            filters : ['xxxx','xxxx']
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });

/cmdb/ci/relationship/listCiCtgByCiRelative.mvc

@RequestMapping("listCiCtgByCiRelative")
@ResponseBody
public String listCiCtgByCiRelative(String ciId, Boolean queryAncestor, String[] attrs)

参     数:

参数名 类型 描述 是否必须
ciId String 配置项id
queryAncestor Boolean 是否递归查询当前类别的顶级类别,默认值为false
attrs String[] 需要返回的属性名称,不指定attrs表示返回全部属性

返 回 值:

  描述 范例
成功 成功信息 {success : true, total : xx, root : []}
失败 错误信息 {  success : false   }

异    常:

编号 描述

示例:

    $.ajax({
        url : "/cmdb/ci/relationship/listCiCtgByCiRelative.mvc",
        type : "post",
        data : {
            ciId : 'xxxx',
            queryAncestor : true | false
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });

/cmdb/ci/relationship/listRelationsRecursion.mvc

@RequestMapping("listRelationsRecursion")
@ResponseBody
public String listRelationsRecursion(String ciId, String[] relationDefIds, String[] categoryIds, boolean deepIn, boolean graphicShow, boolean forImpact, Boolean isSource, Boolean isTarget, String pointId)

参     数:

参数名 类型 描述 是否必须
ciId String 配置项id
relationDefIds String[] 关联关系的定义,用于获取指定关联类型的ci
categoryIds String[] 关联配置项的类别id集合,为空时为查询所有类别
deepIn boolean 是否级联查询获取子类别,默认为false
与categoryIds一起使用才有效,若值为true,
类别id集合的值最好不存在父子关系,以便提高查询效率
graphicShow boolean 是否图形展示,默认为false
forImpact boolean 是否仅用于归因和影响度分析,默认为false
isSource Boolean 是否作为来源节点查询,其与isTarget至少有一个为true,默认为true
isTarget Boolean 是否作为目标节点查询,其与isSource至少有一个为true,默认为true
pointId String 端口id

返 回 值:

  描述 范例
成功 成功信息 {success : true, total : xx, root : []}
失败 错误信息 {  success : false   }

异    常:

编号 描述

示例:

    $.ajax({
        url : "/cmdb/ci/relationship/listRelationsRecursion.mvc",
        type : "post",
        data : {
            ciId : 'xxxx',
            relationDefIds : ['xxxx', 'xxxx'],
            categoryIds : 'xxxx',
            deepIn : true | false,
            isSource : true
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });

/cmdb/ci/relationship/saveGraphView.mvc

@RequestMapping("saveGraphView")
@ResponseBody
public String saveGraphView(String ciId, String pointId, String relationDefIds, String graphXml)

参     数:

参数名 类型 描述 是否必须
ciId String 配置项id
pointId String 端口id
relationDefIds String 关系类型
graphXml String 关系图

返 回 值:

  描述 范例
成功 成功信息 {success : true}
失败 错误信息 {  success : false   }

异    常:

编号 描述

示例:

    $.ajax({
        url : "/cmdb/ci/relationship/saveGraphView.mvc",
        type : "post",
        data : {
            ciId : 'xxxx',
            pointId : 'xxxx',
            relationDefIds : 'xxxx',
            graphXml : true
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });

/cmdb/ci/relationship/getGraphView.mvc

@RequestMapping("getGraphView")
@ResponseBody
public String getGraphView(String ciId, String relationDefIds, String[] categoryIds, boolean deepIn, boolean graphicShow, boolean forImpact, Boolean isSource, Boolean isTarget, String pointId)

参     数:

参数名 类型 描述 是否必须
ciId String 配置项id
relationDefIds String 关联关系的定义,用于获取指定关联类型的ci
categoryIds String[] 关联配置项的类别id集合,为空时为查询所有类别
deepIn boolean 是否级联查询获取子类别,默认为false
与categoryIds一起使用才有效,若值为true,
类别id集合的值最好不存在父子关系,以便提高查询效率
graphicShow boolean 是否图形展示,默认为false
forImpact boolean 是否仅用于归因和影响度分析,默认为false
isSource Boolean 是否作为来源节点查询,其与isTarget至少有一个为true,默认为true
isTarget Boolean 是否作为目标节点查询,其与isSource至少有一个为true,默认为true
pointId String 端口id

返 回 值:

  描述 范例
成功 成功信息 {  success : true, graphXml : ' ', removedRelations : {},   addedRelations : {}, relationCiCtgMap : []}
失败 错误信息 {  success : false   }

异    常:

编号 描述

示例:

    $.ajax({
        url : "/cmdb/ci/relationship/getGraphView.mvc",
        type : "post",
        data : {
            ciId : 'xxxx',
            relationDefIds : 'xxxx',
            categoryIds : ['xxxx', 'xxxx'],
            deepIn : true,
            graphicShow : true,
            forImpact : true,
            isSource : true,
            isTarget : true,
            pointId : 'xxxx'
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });

/cmdb/ci/relationship/downloadImage.mvc

@RequestMapping("downloadImage")
@ResponseBody
public void downloadImage(final HttpServletResponse resp, final HttpServletRequest request, String imageXml, String width, String height)

参     数:

参数名 类型 描述 是否必须
imageXml String 导出图片文件
width String 导出图片宽度
height String 导出图片的高度

返 回 值:

  描述 范例
成功 成功信息
失败 错误信息

异    常:

编号 描述

示例:

    $.ajax({
        url : "/cmdb/ci/relationship/downloadImage.mvc",
        type : "post",
        data : {
            imageXml : 'xxxx',
            width : '100',
            height : '200'
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });

/cmdb/history/baseline/create.mvc

@ResponseBody
@RequestMapping("/baseline/create")
public String createBaseline(String versionId, String baselineName, String comment)

参     数:

参数名 类型 描述 是否必须
versionId String 版本id,为null标识将当前最新快照记录为基线
baselineName String 基线名称,不能为空,不能包含空格
comment String 备注,可空

返 回 值:

  描述 范例
成功 成功信息 {   success : true }

示例:

    $.ajax({
        url : 'cmdb/history/baseline/create.mvc',
        type : 'post',
        data : {
            'versionId' : 'xxxxx',
            'baselineName' : 'baselineName',
            'comment' : 'comment'
        },
        dataType : 'json',
        success : function(data){
            console.info(data);
        }
    });

/cmdb/history/baseline/delete.mvc

传递基线名称,删除基线。

@RequestMapping("/baseline/delete")
@ResponseBody
public String delete(String[] name)

参     数:

参数名 类型 描述 是否必须
name String[] 基线名称数组

返 回 值:

  描述 范例
成功 删除成功 {  success : true   }

异    常:

编号 描述

示例:

    $.ajax({
        url : '/cmdb/history/baseline/delete.mvc',
        type : 'post',
        data : {
            'name' : ['baselineName', 'baselineName']
        },
        dataType : 'json',
        success : function(data){
            console.info(data);
        }
    });

/cmdb/history/baseline/list.mvc

@RequestMapping("/baseline/list")
@ResponseBody
public java.lang.String listBaseline() throws com.otu.core.util.serialize.json.JSONException

返 回 值:

  描述 范例
成功 得到基线列表 {
    success : true,  
     total : xxx,  
     root :[
       {   name : xxx,   description : xxx   },
       {  ……  }
     ]
}
失败 错误信息 {   success : false,   msg : xxx,   code : xxx   }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据序列化异常

示例:

    $.ajax({
        url : 'cmdb/history/baseline/list.mvc',
        type : 'post',
        dataType : 'json',
        success : function(data){
            console.info(data);
        }
    });

比较基线,获取差异信息(即两个基线的快照差异),并不返回记录项原始数据

/cmdb/history/baseline/compare.mvc

@RequestMapping("/baseline/compare")
@ResponseBody
public java.lang.String compareBaseline(java.lang.String newBaseline, java.lang.String oldBaseline) throws com.otu.core.util.serialize.json.JSONException

 

参     数:

参数名 类型 描述 是否必须
newBaseline String 新基线名称,为null则以最新版本为基线
oldBaseline String 旧基线名称

返 回 值:

  描述 范例
成功 得到基线比较结果 {
  success : true,  
   total : xxx,  
   root :{
      newBaseline : 'xx',
      oldBaseline : 'xxxx',
      addRecord : [{id : xxx, paht : xxx},{...}],
      delRecord : [{id : xxx, paht : xxx},{...}],
      modifyRecord : [{id : xxx, paht : xxx}]
   }
}
失败 错误信息 {   success : false,   msg : xxx,   code : xxx   }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据序列化异常

示例:

$.ajax({
    url : 'cmdb/history/baseline/compare.mvc',
    type : 'post',
    dataType : 'json',
    data : {
        newBaseline : 'xxx',
        oldBaseline : 'xxx'
    }
    success : function(data){
        console.info(data);
    }
});

/cmdb/history/baseline/compare/entity.mvc

返回新旧基线下指定记录项的原始数据(json格式)

@RequestMapping("/baseline/compare/entity")
@ResponseBody
public String compareEntityInBaseline(String path, String newBaseline, String oldBaseline) throws JSONException

 

参     数:

参数名 类型 描述 是否必须
path String 所查对象的数据路径, 不可为空
说明:CMDB根据不同的前缀区分不同类型的历史数据,前缀如下:
  • 配置项记录 : CIs
  • 状态数据 :STATUS
  • 关系数据:REFs
  • 类别数据:DEFs/catg_def
  • 属性定义数据: DEFs/attr_def
  • 生命周期定义数据:DEFs/lifecycle_def
  • 关系定义数据:DEFs/relation_def
使用时将前缀与对象ID拼接可得参数path,即 path = 前缀/对象ID
newBaseline String 新基线名称,为null则以最新版本为基线
oldBaseline String 旧基线名称

返 回 值:

  描述 范例
成功 得到基线比较结果 {
  success : true,  
   root :{
      newData : {.....},
      oldData : {.....}
   }
}
失败 错误信息 {   success : false,   msg : xxx,   code : xxx   }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据序列化异常

示例:

$.ajax({
    url : 'cmdb/history/baseline/compare.mvc',
    type : 'post',
    dataType : 'json',
    data : {
        path : '/test/test',
        newBaseline : 'xxx',
        oldBaseline : 'xxx'
    }
    success : function(data){
        console.info(data);
    }
});

/cmdb/history/baseline/revert.mvc

@ResponseBody
@RequestMapping("/baseline/revert")
public String revert(String baseline)

 

参     数:

参数名 类型 描述 是否必须
baseline String 要恢复到的版本基线名称

返 回 值:

  描述 范例
成功 得到基线恢复结果 {   success : true,   }

异    常:

编号 描述

示例:

    $.ajax({
        url : 'cmdb/history/baseline/revert.mvc',
        type : 'post',
        dataType : 'json',
        data : {
            baseline : 'xxx'
        }
        success : function(data){
            console.info(data);
        }
    });
                

/cmdb/history/baseline/isExistBaselineName.mvc

@RequestMapping(value="isExistBaselineName")
@ResponseBody
public java.lang.String isExistBaselineName(java.lang.String name)

参     数:

参数名 类型 描述 是否必须
name String 需要被判断字符串

返 回 值:

  描述 范例
成功 显示是否存在 {   success : true,   exist : true|false   }
失败 失败信息 {   success : false,   msg : xxx,   code : xxx   }

异    常:

编号 描述

示例:

    $.ajax({
        url : "/cmdb/history/baseline/isExistBaselineName.mvc",
        type : "post",
        data : {
            name: "xxx"
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });
                

/cmdb/history/version/list.mvc

@ResponseBody
@RequestMapping("/version/list")
public String listVersion(String path, Integer start, Integer limit) throws JSONException

 

参     数:

参数名 类型 描述 是否必须
path String 所查对象的数据路径,为null时返回所有对象的版本列表
说明:CMDB根据不同的前缀区分不同类型的历史数据,前缀如下:
  • 配置项记录 : CIs
  • 状态数据 :STATUS
  • 关系数据:REFs
  • 类别数据:DEFs/catg_def
  • 属性定义数据: DEFs/attr_def
  • 生命周期定义数据:DEFs/lifecycle_def
  • 关系定义数据:DEFs/relation_def
使用时将前缀与对象ID拼接可得参数path,即 path = 前缀/对象ID
start int 记录的开始下标,为null时从0开始
limit int 每页显示记录数,为null显示余下全部

返 回 值:

  描述 范例
成功 得到版本列表 {
  success : true,  
   total : xxx,  
   root :[
      {versionId : xxx, comment : xxx},
      {versionId : xxx, comment : xxx},
      {versionId : xxx, comment : xxx}
   ]
}
失败 错误信息 {   success : false,   msg : xxx,   code : xxx   }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据序列化异常

示例:

    $.ajax({
        url : 'cmdb/history/version/list.mvc',
        type : 'post',
        dataType : 'json',
        data : {
            path : 'xxx',
            start : 1,
            limit : 5
        }
        success : function(data){
            console.info(data);
        }
    });
                

/cmdb/history/baseline/compare/snapshot.mvc

比较两个版本获取差异信息(即两个版本的快照差异),并不返回记录项原始数据

@RequestMapping("/baseline/compare/snapshot")
@ResponseBody
public String compareSnapshot(String versionNew, String versionOld) throws JSONException

参     数:

参数名 类型 描述 是否必须
versionNew String 新版本id,为null用最新版本
versionOld String 旧版本id

返 回 值:

  描述 范例
成功 得到版本比较结果 {
  success : true,  
   total : xxx,  
   root :{
      newBaseline : 'xx',
      oldBaseline : 'xxxx',
      addRecord : [{id : xxx, paht : xxx},{...}],
      delRecord : [{id : xxx, paht : xxx},{...}],
      modifyRecord : [{id : xxx, paht : xxx}]
   }
}
失败 错误信息 {   success : false,   msg : xxx,   code : xxx   }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据序列化异常

示例:

$.ajax({
    url : 'cmdb/history/baseline/compare.mvc',
    type : 'post',
    dataType : 'json',
    data : {
        versionNew : 'xxx',
        versionOld : 'xxx'
    }
    success : function(data){
        console.info(data);
    }
});

/cmdb/history/version/compare.mvc

返回新旧版本下指定记录项的原始数据(json格式)

@ResponseBody
@RequestMapping("/version/compare")
public String compare(String path, String oldVersion, String newVersion) throws JSONException

 

参     数:

参数名 类型 描述 是否必须
path String 所查对象的数据路径, 不可为空
说明:CMDB根据不同的前缀区分不同类型的历史数据,前缀如下:
  • 配置项记录 : CIs
  • 状态数据 :STATUS
  • 关系数据:REFs
  • 类别数据:DEFs/catg_def
  • 属性定义数据: DEFs/attr_def
  • 生命周期定义数据:DEFs/lifecycle_def
  • 关系定义数据:DEFs/relation_def
使用时将前缀与对象ID拼接可得参数path,即 path = 前缀/对象ID
oldVersion String 旧版本id
newVersion String 新版本id

返 回 值:

  描述 范例
成功 得到版本比较结果 {
  success : true,  
   root :{
      "newData" : {id : xxx, name : xxx,...},
       "oldData" : {id : xxx, name : xxx,...}
   }
}
失败 错误信息 {   success : false,   msg : xxx,   code : xxx   }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据序列化异常

示例:

$.ajax({
    url : 'cmdb/history/version/compare.mvc',
    type : 'post',
    dataType : 'json',
    data : {
        path : 'xxx'
        oldVersion :  oldVersionId  
        newVersion : newVersionId
    }
    success : function(data){
        console.info(data);
    }
});

/cmdb/history/version/data.mvc

@ResponseBody
@RequestMapping("/version/data")
public String getData(String path, String version, String baseline)

 

参     数:

参数名 类型 描述 是否必须
path String 所查对象的数据路径, 不可为空
说明:CMDB根据不同的前缀区分不同类型的历史数据,前缀如下:
  • 配置项记录 : CIs
  • 状态数据 :STATUS
  • 关系数据:REFs
  • 类别数据:DEFs/catg_def
  • 属性定义数据: DEFs/attr_def
  • 生命周期定义数据:DEFs/lifecycle_def
  • 关系定义数据:DEFs/relation_def
使用时将前缀与对象ID拼接可得参数path,即 path = 前缀/对象ID
version String 版本id,与baseline任选一,同时存在以version为准
baseline String 基线名称,与version任选一,同时存在以version为准

返 回 值:

  描述 范例
成功 得到基线比较结果 {
  success : true,  
   root :{
      data : {id : xxx, code : xxx,...}
   }
}
失败 错误信息 {   success : false,   msg : xxx,   code : xxx   }

异    常:

编号 描述

示例:

    $.ajax({
        url : 'cmdb/history/version/data.mvc',
        type : 'post',
        dataType : 'json',
        data : {
            path : 'xxx',
            version : 'xxx'
        }
        success : function(data){
            console.info(data);
        }
    });
                

/cmdb/ci/resource/enums/list.mvc

@RequestMapping(value="list")
@ResponseBody
public java.lang.String listEnums(@RequestParam Map<String, Object> props, String[] attrs) throws com.otu.core.util.serialize.json.JSONException

参     数:

参数名 类型 描述 是否必须
props Map<String, Object> 查询数据的条件列表,为空时返回全部数据
attrs String[] 返回的属性列表,为空时返回全部属性

返 回 值:

  描述 范例
成功 明细信息 {
  success : true,
  total : xxx,
  root :[  {  id : xxx,  name : xxx,  ......  }  ]
}
失败 错误信息 {   success : false,    msg : xxx,    code : xxx    }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据序列化异常

示例:

    $.ajax({ 
        url : "/cmdb/ci/resource/enums/list.mvc", 
        type : "post",
        data : { 
            start : 0,
            limit : 10,
            'name*like' : 'xxx',
            ...
        }, 
        dataType : "json", 
        success : function(data) { 
            alert(data);
        } 
    });
                

/cmdb/ci/resource/enums/add.mvc

@RequestMapping("add")
@ResponseBody
public java.lang.String addEnumItem(java.lang.String dataSign, java.lang.String tag, java.lang.String name, java.lang.String code, java.lang.String description, java.lang.String dataSignDescription)

参     数:

参数名 类型 描述 是否必须
dataSign String 区分不同数据字典类别的标识
tag String 区分不同数据字典分组的标识
name String 名称
code String 编码
description String 描述
dataSignDescription String 数据字典描述

返 回 值:

  描述 范例
成功 枚举值的明细信息 {
   success : true,  
   root :{  id : xxx,  name :xxx,  dataSign: xxx  ......  }
}
失败 错误信息 {   success : false,    msg : xxx,    code : xxx    }

异    常:

编号 描述

示例:

    $.ajax({
        url : '/cmdb/ci/resource/enums/add.mvc',
        data : {
            'dataSign' : 'xxx',
            'name' : 'xxx',
            'code' : 'xxx',
            'tag' : 'xxx',
            'description' : 'xxx',
            'dataSignDescription' : 'xxx'
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });
                

/cmdb/ci/resource/enums/addItems.mvc

添加多条字典项

@RequestMapping("addItems")
@ResponseBody
public java.lang.String addEnumItems(java.lang.String dataSign, java.lang.String tag, java.lang.String description, java.lang.String dataSignDescription, java.lang.String[] data)

参     数:

参数名 类型 描述 是否必须
dataSign String 区分不同数据字典类别的标识
tag String 区分不同数据字典分组的标识
description String 描述
dataSignDescription String 数据字典描述
data String[] 字典值数据

返 回 值:

  描述 范例
成功 枚举值的明细信息 {
   success : true,  
}
失败 错误信息 {   success : false,    msg : xxx,    code : xxx    }

异    常:

编号 描述

示例:

    $.ajax({
        url : '/cmdb/ci/resource/enums/addItems.mvc',
        data : {
            'dataSign' : 'xxx',
            'tag' : 'xxx',
            'description' : 'xxx',
            'dataSignDescription' : 'xxx',
            'data' : []
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });
                

/cmdb/ci/resource/enums/update.mvc

@RequestMapping("update")
@ResponseBody
public java.lang.String updateEnum(com.dhcc.cmdb.model.support.directory.GenericEntity genericEntity)

参     数:

参数名 类型 描述 是否必须
genericEntity com.dhcc.cmdb.model.support.directory.GenericEntity 枚举对象

返 回 值:

  描述 范例
成功 枚举值的明细信息 {
   success : true,  
   root :{  id : xxx,  name :xxx,  dataSign: xxx  ......  }
}
失败 错误信息 {   success : false,    msg : xxx,    code : xxx    }

异    常:

编号 描述

示例:

    $.ajax({
        url : '/cmdb/ci/resource/enums/update.mvc',
        data : {
            id : 'xxx',
            name : 'xxx',
            code : 'xxx',
            description : 'xxx',
            dataSignDescription : 'xxx',
            dataSign : 'xxx',
            tag : 'xxx'
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });
                

/cmdb/ci/resource/enums/delete.mvc

@RequestMapping(value="delete")
@ResponseBody
public String deleteEnum(String dataSign, String code)

参     数:

参数名 类型 描述 是否必须
dataSign String 区分不同数据类别的dataSign
code String code

返 回 值:

  描述 范例
成功 删除成功 {  success : true   }
失败 删除失败 {  success : false    }

异    常:

编号 描述

示例:

    $.ajax({
        url : '/cmdb/ci/resource/enums/delete.mvc',
        data : {
            'id' : 'xxx',
            'dataSign' : 'test'
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });

/cmdb/ci/resource/enums/bulkDelete.mvc

批量删除枚举值

@RequestMapping(value="bulkDelete")
@ResponseBody
public String bulkDeleteEnum(String[] ids)

参     数:

参数名 类型 描述 是否必须
ids String[] 需删除的枚举值id数组

返 回 值:

  描述 范例
成功 删除成功 {  success : true   }
失败 删除失败 {  success : false    }

异    常:

编号 描述

示例:

    $.ajax({
        url : '/cmdb/ci/resource/enums/bulkDelete',
        data : {
            'ids' : ['xxx1', 'xxx2']
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });

/cmdb/ci/resource/enums/get.mvc

@RequestMapping("get")
@ResponseBody
public java.lang.String getEnum(java.lang.String id)

参     数:

参数名 类型 描述 是否必须
id String 枚举id

返 回 值:

  描述 范例
成功 枚举值的明细信息 {
   success : true,  
   root :{  id : xxx,  name :xxx,  dataSign: xxx  ......  }
}
失败 错误信息 {   success : false,    msg : xxx,    code : xxx    }

异    常:

编号 描述

示例:

    $.ajax({
        url : '/cmdb/ci/resource/enums/get.mvc',
        data : {
            'id' : 'xxx'
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });
                

/cmdb/ci/resource/enums/listDataSign.mvc

@RequestMapping("listDataSign")
@ResponseBody
public java.lang.String listDataSign(@RequestParam Map<String, Object> props)

参     数:

参数名 类型 描述 是否必须
props Map<String, Object> 对dataSign属性进行约束查询

返 回 值:

  描述 范例
成功 获取成功 {
   success : true,  
   total : xxx,  
   root :{  id : xxx,  name :xxx,  dataSign: xxx  ......  }
}
失败 错误信息 {   success : false,    msg : xxx,    code : xxx    }

异    常:

编号 描述

示例:

    $.ajax({
        url : '/cmdb/ci/resource/enums/listDataSign.mvc',
        data : {
            'name*eq' : 'xxx',
            ...
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });
                

/cmdb/ci/resource/enums/updateDataDictionary.mvc

@RequestMapping("updateDataDictionary")
@ResponseBody
public java.lang.String updateDataDictionary(String tag, String description, String dataSignDescription, String newdataSign, String oldDataSign)

参     数:

参数名 类型 描述 是否必须
tag String 分组标签
description String 描述
dataSignDescription String 数据字典描述
newdataSign String 新分类标记
oldDataSign String 旧分类标记

返 回 值:

  描述 范例
成功 枚举值的明细信息 {
   success : true,  
   root :{  id : xxx,  name :xxx,  dataSign: xxx  ......  }
}
失败 错误信息 {   success : false,    msg : xxx,    code : xxx    }

异    常:

编号 描述

示例:

    $.ajax({
        url : '/cmdb/ci/resource/enums/updateDataDictionary.mvc',
        data : {
            tag : 'xxx',
            description : 'xxx',
            dataSignDescription : 'xxx',
            newdataSign : 'xxx',
            olddataSign : 'xxx'
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });
                

/cmdb/ci/resource/enums/deleteDataDictionary.mvc

@RequestMapping(value="deleteDataDictionary")
@ResponseBody
public String deleteDataDictionary(String dataSign)

参     数:

参数名 类型 描述 是否必须
dataSign String 区分不同数据类别的dataSign

返 回 值:

  描述 范例
成功 删除成功 {  success : true   }
失败 删除失败 {  success : false    }

异    常:

编号 描述

示例:

    $.ajax({
        url : '/cmdb/ci/resource/enums/deleteDataDictionary.mvc',
        data : {
            'dataSign' : 'test'
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });

/cmdb/ci/resource/enums/listTags.mvc

@RequestMapping("listTags")
@ResponseBody
public java.lang.String listTags()

返 回 值:

  描述 范例
成功 获取成功 {
   success : true,  
   total : xxx,  
   root :{  id : xxx,  name :xxx,  dataSign: xxx  ......  }
}
失败 错误信息 {   success : false,    msg : xxx,    code : xxx    }

异    常:

编号 描述

示例:

    $.ajax({
        url : '/cmdb/ci/resource/enums/listTags.mvc',
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });
                

cmdb/ci/resource/tree_enums/list.mvc

@RequestMapping(value="list")
@ResponseBody
public java.lang.String listTreeEnums(@RequestParam Map<String, Object> props, String[] attrs)

参     数:

参数名 类型 描述 是否必须
props Map<String, Object> 条件查询列表
attrs String[] 返回数据的属性,为空时返回所有属性

返 回 值:

  描述 范例
成功 明细信息 {
  success : true,
  total : xxx,
  root :[  {  id : xxx,  name : xxx,  ......  }  ]
}
失败 错误信息 {   success : false,    msg : xxx,    code : xxx    }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据序列化异常

示例:

    $.ajax({
        url : "cmdb/ci/resource/tree_enums/list.mvc",
        type : "post",
        data : {
            'name*eq' : 'xxx',
            ...
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });
                

cmdb/ci/resource/tree_enums/listSearch.mvc

树型枚举关键字查询

@RequestMapping(value="listSearch")
@ResponseBody
public java.lang.String listTreeDataSign(@RequestParam Map<String, Object> props)

参     数:

参数名 类型 描述 是否必须
dataSign*like String 对dataSign属性进行约束查询

返 回 值:

  描述 范例
成功 明细信息 {
  success : true,
  total : xxx,
  root :[  {  id : xxx,  name : xxx,  ......  }  ]
}
失败 错误信息 {   success : false,    msg : xxx,    code : xxx    }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据序列化异常

示例:

$.ajax({
    url : "cmdb/ci/resource/tree_enums/listSearch.mvc",
    type : "post",
    data : {
        'dataSign*like' : 'xxx'
    },
    dataType : "json",
    success : function(data) {
        alert(data);
    }
});
            

cmdb/ci/resource/tree_enums/add.mvc

@RequestMapping("add")
@ResponseBody
public java.lang.String addTreeEnumItem(@RequestParam Map>String, Object< props)

参     数:

参数名 类型 描述 是否必须
dataSign String 分类标识
name String 名称
code String 字典值
parent.id String 父字典ID
description String 描述

返 回 值:

  描述 范例
成功 树形枚举值明细信息 {
   success : true,  
   root :{  id : xxx,  name :xxx,  parent: xxx  ......  }
}
失败 错误信息 {   success : false,    msg : xxx,    code : xxx    }

异    常:

编号 描述

示例:

    $.ajax({
        url : 'cmdb/ci/resource/tree_enums/add.mvc',
        data : {
            'dataSign' : 'xxx',
            'name' : 'xxx',
            'code' : 'xxx'
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });
                

cmdb/ci/resource/tree_enums/addItems.mvc

添加多条树形字典项

@RequestMapping("addItems")
@ResponseBody
public java.lang.String addTreeEnumItems(String dataSign, String tag, String description, String dataSignDescription, String[] data)

参     数:

参数名 类型 描述 是否必须
dataSign String 分类标识
tag String 分组标签
description String 描述
dataSignDescription String 数据字典描述
data String[]

返 回 值:

  描述 范例
成功 树形枚举值明细信息 {
   success : true,  
   root :{  id : xxx,  name :xxx,  parent: xxx  ......  }
}
失败 错误信息 {   success : false,    msg : xxx,    code : xxx    }

异    常:

编号 描述

示例:

    $.ajax({
        url : 'cmdb/ci/resource/tree_enums/addItems.mvc',
        data : {
            dataSign : 'xx',
            data : [
              '{name : "a1", code : "a1" }', 
              '{name : "a2", code : "a2", parentId : "xxxx", child : [{name : "c1", code: "c1"}, {name : "c2", code: "c2", child : [{name : "g1", code: "g1"}] } ] }'
            ],
            tag : 'xx',
            description : 'xx',
            dataSignDescription : 'xx'
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });
                

/cmdb/ci/resource/tree_enums/update.mvc

@RequestMapping("update")
@ResponseBody
public java.lang.String updateTreeEnumItem(String id, @RequestParam Map props)

参     数:

参数名 类型 描述 是否必须
id String 树型枚举id
dataSign String 分类标识
name String 名称
code String 字典值
parent.id String 父字典ID
description String 描述

返 回 值:

  描述 范例
成功 枚举值的明细信息 {
   success : true,  
   root :{  id : xxx,  name :xxx,  dataSign: xxx  ......  }
}
失败 错误信息 {   success : false,    msg : xxx,    code : xxx    }

异    常:

编号 描述

示例:

    $.ajax({
        url : '/cmdb/ci/resource/tree_enums/update.mvc',
        data : {
            id : 'xxx',
            name : 'xxx',
            code : 'xxx',
            description : 'xxx',
            dataSignDescription : 'xxx',
            dataSign : 'xxx',
            tag : 'xxx'
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });
                

删除树形字典项,强制约束,存有子类时不允许删除

cmdb/ci/resource/tree_enums/delete.mvc

@RequestMapping(value="delete")
@ResponseBody
public String deleteTreeEnum(String dataSign, String code)

参     数:

参数名 类型 描述 是否必须
dataSign String 分类标识,当其他参数都为空时表示删除整个字典分类
code String 字典值

返 回 值:

  描述 范例
成功 删除成功 {  success : true   }
失败 删除失败 {  success : false    }

异    常:

编号 描述

示例:

    $.ajax({
        url : 'cmdb/ci/resource/tree_enums/delete.mvc',
        data : {
            'dataSign' : 'test',
            'code' : 'xxx'
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });
                

cmdb/ci/resource/tree_enums/deleteById.mvc

根据id删除单条树型枚举

@ResponseBody
@RequestMapping(value="deleteById")
public String deleteTreeEnumById(String id)

参     数:

参数名 类型 描述 是否必须
id String 树型枚举id

返 回 值:

  描述 范例
成功 删除成功 {  success : true   }
失败 删除失败 {  success : false    }

异    常:

编号 描述

示例:

    $.ajax({
        url : 'cmdb/ci/resource/tree_enums/deleteById.mvc',
        data : {
            'id' : 'xxx'
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });

cmdb/ci/resource/tree_enums/blukDelete.mvc

批量删除树形枚举值,在此做强制约束,如有子类,跳过不做删除

@ResponseBody
@RequestMapping(value="blukDelete")
public String blukDeleteTreeEnum(String[] ids)

参     数:

参数名 类型 描述 是否必须
ids String[] id数组

返 回 值:

  描述 范例
成功 删除成功 {  success : true   }
失败 删除失败 {  success : false    }

异    常:

编号 描述

示例:

    $.ajax({
        url : 'cmdb/ci/resource/tree_enums/bulkDelete.mvc',
        data : {
            'ids' : ['xxx', 'xxx']
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });

/cmdb/ci/resource/tree_enums/get.mvc

@RequestMapping("get")
@ResponseBody
public java.lang.String getTreeEnumItem(java.lang.String id)

参     数:

参数名 类型 描述 是否必须
id String 树型枚举id

返 回 值:

  描述 范例
成功 枚举值的明细信息 {
   success : true,  
   root :{  id : xxx,  name :xxx,  dataSign: xxx  ......  }
}
失败 错误信息 {   success : false,    msg : xxx,    code : xxx    }

异    常:

编号 描述

示例:

    $.ajax({
        url : '/cmdb/ci/resource/tree_enums/get.mvc',
        data : {
            'id' : 'xxx'
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });
                

/cmdb/ci/resource/tree_enums/listDataSign.mvc

@RequestMapping("listDataSign")
@ResponseBody
public java.lang.String listDataSign(@RequestParam Map<String, Object> props)

参     数:

参数名 类型 描述 是否必须
props Map<String, Object> 对dataSign属性进行约束查询

返 回 值:

  描述 范例
成功 获取成功 {
   success : true,  
   total : xxx,  
   root :{  id : xxx,  name :xxx,  dataSign: xxx  ......  }
}
失败 错误信息 {   success : false,    msg : xxx,    code : xxx    }

异    常:

编号 描述

示例:

    $.ajax({
        url : '/cmdb/ci/resource/tree_enums/listDataSign.mvc',
        data : {
            'name*eq' : 'xxx',
            ...
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });
                

/cmdb/ci/resource/tree_enums/updateDataDictionary.mvc

@RequestMapping("updateDataDictionary")
@ResponseBody
public java.lang.String updateDataDictionary(String tag, String description, String dataSignDescription, String newdataSign, String oldDataSign)

参     数:

参数名 类型 描述 是否必须
tag String 分组标签
description String 描述
dataSignDescription String 数据字典描述
newdataSign String 新分类标记
oldDataSign String 旧分类标记

返 回 值:

  描述 范例
成功 枚举值的明细信息 {
   success : true,  
   root :{  id : xxx,  name :xxx,  dataSign: xxx  ......  }
}
失败 错误信息 {   success : false,    msg : xxx,    code : xxx    }

异    常:

编号 描述

示例:

    $.ajax({
        url : '/cmdb/ci/resource/tree_enums/updateDataDictionary.mvc',
        data : {
            tag : 'xxx',
            description : 'xxx',
            dataSignDescription : 'xxx',
            newdataSign : 'xxx',
            olddataSign : 'xxx'
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });
                

/cmdb/ci/resource/tree_enums/deleteDataDictionary.mvc

@RequestMapping(value="deleteDataDictionary")
@ResponseBody
public String deleteDataDictionary(String dataSign)

参     数:

参数名 类型 描述 是否必须
dataSign String 区分不同数据类别的dataSign

返 回 值:

  描述 范例
成功 删除成功 {  success : true   }
失败 删除失败 {  success : false    }

异    常:

编号 描述

示例:

    $.ajax({
        url : '/cmdb/ci/resource/tree_enums/deleteDataDictionary.mvc',
        data : {
            'dataSign' : 'test'
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });

/cmdb/ci/resource/tree_enums/listTags.mvc

@RequestMapping("listTags")
@ResponseBody
public java.lang.String listTags()

返 回 值:

  描述 范例
成功 获取成功 {
   success : true,  
   total : xxx,  
   root :{  id : xxx,  name :xxx,  dataSign: xxx  ......  }
}
失败 错误信息 {   success : false,    msg : xxx,    code : xxx    }

异    常:

编号 描述

示例:

    $.ajax({
        url : '/cmdb/ci/resource/tree_enums/listTags.mvc',
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });
                

/cmdb/tools/discover/scan.mvc

调用网管部的网络发现工具,其配置通过网络发现工具自身设定,查询过程是同步的,其运行的结果输出在自动发现工具的data目录下,下一次运行的结果会覆盖上一次运行的结果

@ResponseBody
@RequestMapping("scan")
public String discover( )

返 回 值:

  描述 范例
成功 成功信息 { success : true }

异    常:

编号 描述

示例:

$.ajax({
    url : '/cmdb/tools/discover/scan.mvc',
    type : "post",
    dataType : "json",
    success : function(data) {
        alert(data);
    }
});

/cmdb/tools/discover/detail.mvc

获取某个ip设备的详细参数

@ResponseBody
@RequestMapping("detail")
public String getDetail(String manageIp) throws JSONException

参     数:

参数名 类型 描述 是否必须
manageIp String 设备ip

返 回 值:

  描述 范例
成功 配置项的明细信息 {
   success : true,  
   root :{  id : xxx,  name :xxx,  category: xxx  ......  }
}
失败 错误信息 {  success : false,   msg : xxx,   code : xxx   }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据序列化异常

示例:

$.ajax({
    url : '/cmdb/tools/discover/detail.mvc',
    type : "post",
    dataType : "json",
    data : {
        manageIp : 'xxxxx'
    }
    success : function(data) {
        alert(data);
    }
});

/cmdb/tools/sandbox/create.mvc

@RequestMapping("/create")
@ResponseBody
public String create(String dataSrc, String baselineName) throws JSONException

参     数:

参数名 类型 描述 是否必须
dataSrc string 数据源,CMDB提供了三种初始化数据方式:
  • current,当前数据库(dataSrc为空默认为此方式)
  • empty, CMDB系统的原始数据
  • baseline, 指定基线
baselineName string 指定基线名称,只有当dataSrc为baseline时,此参数才起作用

返 回 值:

  描述 范例
成功 房间的明细信息 {
   success : true,  
   root :{sandboxName : xxx}
}
失败 错误信息 {   success : false,    msg : xxx,    code : xxx    }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据解析异常

示例:

  $.ajax({
       url : '/cmdb/tools/sandbox/create.mvc',
       data : {
           dataSrc : current  //正式CMDB库,dataSrc为空时默认此方式
       }
  });
  
  $.ajax({
       url : '/cmdb/tools/sandbox/create.mvc',
       data : {
           dataSrc : 'empty' //空的CMDB库
       }
  });
  $.ajax({
       url : '/cmdb/tools/sandbox/create.mvc',
       data : {
           dataSrc : 'baseline',  //基于某个基线的CMDB库
           baselineName : 'xxxx'
       }
  });

/cmdb/tools/sandbox/open.mvc

@ResponseBody
@RequestMapping("/open")
public String open(String name)

参     数:

参数名 类型 描述 是否必须
name String 沙盒名称

返 回 值:

  描述 范例
成功 成功信息 { success : true}
失败 错误信息 {   success : false,   msg : xxx,   code : xxx }

异    常:

编号 描述

示     例:

    $.ajax({
        url : '/cmdb/tools/sandbox/open.mvc',
        type : 'post',
        data : {
            'name' : 'name'
        },
        dataType : 'json',
        success : function(data) {
            alert(data);
        }
    });

/cmdb/tools/sandbox/close.mvc

关闭沙盒的spring context和数据库连接以释放内存资源

@ResponseBody
@RequestMapping("/close")
public String close(String name)

参     数:

参数名 类型 描述 是否必须
name string 沙盒名称

返 回 值:

  描述 范例
成功 房间的明细信息 {success : true}
失败 错误信息 {   success : false,    msg : xxx,    code : xxx    }

异    常:

编号 描述

示例:

    $.ajax({
        url : '/cmdb/tools/sandbox/close.mvc',
        type : 'post',
        data : {
            'name' : 'xxxx'
        },
        dataType : 'json',
        success : function(data) {
            alert(data);
        }
    });

/cmdb/tools/sandbox/destroy.mvc

沙盒销毁是指将沙盒进行物理删除,删除其在磁盘上的H2数据库文件的过程。为了保证删除的成功,在删除操作前,会执行沙盒关闭操作

@ResponseBody
@RequestMapping("/destroy")
public String destroy(String name)

参     数:

参数名 类型 描述 是否必须
name String 沙盒名称

返 回 值:

  描述 范例
成功 销毁成功 {  success : true   }
失败 错误信息 {   success : false,    msg : xxx,    code : xxx    }

异    常:

编号 描述

示例:

    $.ajax({
        url : '/cmdb/tools/sandbox/destroy.mvc',
        data : {
            'name' : 'xxx',
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });

/cmdb/tools/sandbox/list.mvc

获取某个楼层下所有房间的信息

@ResponseBody
@RequestMapping("/list")
public String list() throws JSONException

参     数:

参数名 类型 描述 是否必须

返 回 值:

  描述 范例
成功 得到房间数据 {
  success : true,
  total : xxx,
  root :[  {  name : xxx},{......}  ]
}
失败 错误信息 {   success : false,    msg : xxx,    code : xxx    }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据序列化异常

示例:

    $.ajax({ 
        url : '/cmdb/tools/sandbox/list.mvc', 
        type : 'post',
        dataType : 'json', 
        success : function(data) { 
            alert(data);
        } 
    });

/cmdb/tools/sandbox/{sandboxName}/**

CMDB在web接口上也保持了与正式库一致性体验,只需在操作正式库的请求路径上加入需操作的沙盒的信息即可,其它路径和参数都保持了一致

@ResponseBody
@RequestMapping("/{sandboxName}/**")
public void operate(@PathVariable String sandboxName, HttpServletRequest req, HttpServletResponse res) throws Exception

参     数:

参数名 类型 描述 是否必须
sandboxName string 沙盒名称(注意:此为路径参数)

返 回 值:

  描述 范例

异    常:

编号 描述

示例:

   =============以创建配置项CI为例,演示正式库操作和沙盒操作=============
   
//正式库使用代码:
$.ajax({
    url : '/cmdb/ci/create.mvc',
    data : {
        'categoryId' : 'xxx',
        'name' : 'xxx',
        'assertNO' : 'xxx',
        'status.id' : 'xxx'
    },
    dataType : "json",
    success : function(data) {
        alert(data);
    }
});

//沙盒使用代码:
$.ajax({
    url : '/cmdb/tools/sandbox/{sandboxName}/ci/create.mvc',  // 只在原url上增加"/tools/sandbox/{sandboxName}"即可,
                                                                 sandboxName为要操作沙盒的名字
    data : {
        'categoryId' : 'xxx',
        'name' : 'xxx',
        'assertNO' : 'xxx',
        'status.id' : 'xxx'
    },
    dataType : "json",
    success : function(data) {
        alert(data);
    }
});

/cmdb/tools/sandbox/applySandbox/{sandboxName}.mvc

将沙盒数据应用到正式库

考虑权限和安全问题,不应用沙盒中删除的操作,只应用添加和修改的操作,并且记录基线

@ResponseBody @RequestMapping("/applySandbox/{sandboxName}") public String applySandbox(@PathVariable String sandboxName)

参     数:

参数名 类型 描述 是否必须
sandboxName string 沙盒名称(路径参数)

返 回 值:

  描述 范例
成功 房间的明细信息 {success : true}
失败 错误信息 {   success : false,    msg : xxx,    code : xxx    }

异    常:

编号 描述

示例:

    $.ajax({
        url : '/cmdb/tools/sandbox/applySandbox/test.mvc', //test为沙盒名称
        type : 'post',
        dataType : 'json',
        success : function(data) {
            alert(data);
        }
    });

/cmdb/ci/region/list.mvc

获取某个区域下所有子区域的信息

@RequestMapping("/list")
@ResponseBody
public String list(@RequestParam Map<String, Object> props, String[] attrs) throws JSONException

参     数:

参数名 类型 描述 是否必须
parentId String 上一级区域的id

返 回 值:

  描述 范例
成功 得到区域数据 {
  success : true,
  total : xxx,
  root :[  {  id : xxx,  name : xxx,  ......  }  ]
}
失败 错误信息 {   success : false,    msg : xxx,    code : xxx    }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据序列化异常

示例:

    $.ajax({ 
        url : '/cmdb/ci/region/list.mvc', 
        type : 'post',
        data : { 
           'attrs' : ['name','region.name','region.id',...] // 不包含此参数表示返回全部信息
           'start' : 0,
           'limit' : 20,
           'sortName' : 'name',    //排序的属性
           'sortOrder' : 'desc'    //升序排序或降序排序,asc|desc,默认为asc(升序排序)
           
           //复杂条件组合,和以上参数区别开来(以下示例参数只做教程说明,并非region的属性,使用时请注意)
           'name' : 'xxx', // 查询name = xxx 的记录,没有后缀默认为eq
           'name*eq' : 'xxx', // 查询name =xxx 的记录,eq可省略
           'apPortCount*gt' : 'xxx', // 查询apPortCount > xxx 的记录,
           'apPortCount*lt' : 'xxx', // 查询apPortCount < xxx 的记录,
           'apPortCount*ge' : 'xxx', // 查询apPortCount >= xxx 的记录,
           'apPortCount*le' : 'xxx', // 查询apPortCount <= xxx 的记录,
           'apPortCount*like' : 'xxx',    //查询apPortCount like '%xxx%' 的记录, 后台自动封装%
           'apPortCount*notLike' : 'xxx', // 查询去除apPortCount like '%xxx%'的记录,后台自动封装%
           'id*in' : 'xx1,xx2', // 查询id 为'xx1'或'xx2'的记录, id以','分隔
           'id*notIn' : 'xx1,xx2', // 查询id 不为'xx1'和'xx2'的记录, id以','分隔
        }, 
        dataType : 'json', 
        success : function(data) { 
            alert(data);
        } 
    });

/cmdb/ci/region/add.mvc

@RequestMapping("/add")
@ResponseBody
public java.lang.String add(Region region) throws com.otu.core.util.serialize.json.JSONException

参     数:

参数名 类型 描述 是否必须
name string 区域名称
description string 区域描述
parent.id string 父区域id

返 回 值:

  描述 范例
成功 区域的明细信息 {
   success : true,  
   root :{  id : xxx,  name :xxx,  parent: xxx  ......  }
}
失败 错误信息 {   success : false,    msg : xxx,    code : xxx    }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据解析异常

示例:

    $.ajax({
        url : '/cmdb/ci/region/add.mvc',
        data : {
            'region' : {
                'name' : '长沙',
                'description' : 'xxxxx',
                'parent.id' : 'xxxxxxx'
            }
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });

/cmdb/ci/region/update.mvc

@RequestMapping(value="/update")
@ResponseBody
public java.lang.String update(Region region) throws com.otu.core.util.serialize.json.JSONException

参     数:

参数名 类型 描述 是否必须
id String 修改的region的id
name String 名称
parent.id String 父区域id
description String 描述

返 回 值:

  描述 范例
成功 新区域的明细信息 {
  success : true,
  root :{  id : xxx,  name :xxx,  parent : xxx  }
}
失败 错误信息 {   success : false,   msg : xxx,   code : xxx }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据解析异常

示     例:

    $.ajax({
        url : '/cmdb/ci/region/update.mvc',
        type : 'post',
        data : {
            'id' : 'xxxx',
            'name' : 'name',
            'parent.id' : 'xxxxxx',
            'description' : 'xxxx'
        },
        dataType : 'json',
        success : function(data) {
            alert(data);
        }
    });

/cmdb/ci/region/delete.mvc

@RequestMapping(value="/delete")
@ResponseBody
public java.lang.String delete(java.lang.String id)

参     数:

参数名 类型 描述 是否必须
id String id

返 回 值:

  描述 范例
成功 删除成功 {  success : true   }
失败 删除失败 {  success : false    }

异    常:

编号 描述

示例:

    $.ajax({
        url : '/cmdb/ci/region/delete.mvc',
        data : {
            'id' : 'xxx',
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });

/cmdb/ci/region/bulkDelete.mvc

批量删除,若有对象在系统中存在约束不能删除时,回滚全部删除操作

@RequestMapping(value="/bulkDelete")
@ResponseBody
public String bulkDelete(String[] ids)

参     数:

参数名 类型 描述 是否必须
ids String[] id数组

返 回 值:

  描述 范例
成功 删除成功 {  success : true   }
失败 删除失败 {  success : false    }

异    常:

编号 描述

示例:

$.ajax({
    url : '/cmdb/ci/region/bulkDelete.mvc',
    data : {
        'ids' : ['xxx1','xxx2']
    },
    dataType : "json",
    success : function(data) {
        alert(data);
    }
});

/cmdb/ci/region/get.mvc

@RequestMapping(value="/get")
@ResponseBody
public java.lang.String get(String id) throws com.otu.core.util.serialize.json.JSONException

参     数:

参数名 类型 描述 是否必须
id String 修改的region的id

返 回 值:

  描述 范例
成功 新区域的明细信息 {
  success : true,
  root :{  id : xxx,  name :xxx,  parent : xxx  }
}
失败 错误信息 {   success : false,   msg : xxx,   code : xxx }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据解析异常

示     例:

    $.ajax({
        url : '/cmdb/ci/region/get.mvc',
        type : 'post',
        data : {
            'id' : 'xxxx'
        },
        dataType : 'json',
        success : function(data) {
            alert(data);
        }
    });

/cmdb/ci/building/list.mvc

获取某个区域下所有子区域的信息

@RequestMapping("/list")
@ResponseBody
public String list(@RequestParam Map<String, Object> props, String[] attrs) throws JSONException

参     数:

参数名 类型 描述 是否必须
attrs String 需要显示的属性列表,为空时全部返回
start int 开始索引
limit int 页大小
sortName String 排序属性
sortOrder String 排序顺序,asc | desc, 默认asc(升序)
name String 名称
status.id String 状态ID
…… …… 查询参数列表,参数可添加后缀进行复杂匹配,props更多查阅 JAVA API 中Building的属性
说明:CMDB根据不同的后缀封装查询条件,后缀如下:
  • = : eq
  • > :gt
  • < :lt
  • >= :ge
  • <= : le
  • like :like
  • in :in
  • notIn :notIn
  • notLike :notLike
使用时将属性与后缀以*分割拼接即可,即 属性名称*后缀 : 'xxx',因此接口只返回通用信息,故匹配的属性必须在通用信息中国,还可参考下面的详细示例教程

返 回 值:

  描述 范例
成功 得到楼宇数据 {
  success : true,
  total : xxx,
  root :[  {  id : xxx,  name : xxx,  ......  }  ]
}
失败 错误信息 {   success : false,    msg : xxx,    code : xxx    }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据序列化异常

示例:

$.ajax({ 
    url : '/cmdb/ci/building/list.mvc', 
    type : 'post',
    data : { 
       'attrs' : ['name','region.name','region.id',...] // 不包含此参数表示返回全部信息
       'start' : 0,
       'limit' : 20,
       'sortName' : 'name',    //排序的属性
       'sortOrder' : 'desc'    //升序排序或降序排序,asc|desc,默认为asc(升序排序)
       
       //复杂条件组合,和以上参数区别开来(以下示例参数只做教程说明,并非building的属性,使用时请注意)
       'name' : 'xxx', // 查询name = xxx 的记录,没有后缀默认为eq
       'name*eq' : 'xxx', // 查询name =xxx 的记录,eq可省略
       'apPortCount*gt' : 'xxx', // 查询apPortCount > xxx 的记录,
       'apPortCount*lt' : 'xxx', // 查询apPortCount < xxx 的记录,
       'apPortCount*ge' : 'xxx', // 查询apPortCount >= xxx 的记录,
       'apPortCount*le' : 'xxx', // 查询apPortCount <= xxx 的记录,
       'apPortCount*like' : 'xxx',    //查询apPortCount like '%xxx%' 的记录, 后台自动封装%
       'apPortCount*notLike' : 'xxx', // 查询去除apPortCount like '%xxx%'的记录,后台自动封装%
       'id*in' : 'xx1,xx2', // 查询id 为'xx1'或'xx2'的记录, id以','分隔
       'id*notIn' : 'xx1,xx2', // 查询id 不为'xx1'和'xx2'的记录, id以','分隔
    }, 
    dataType : 'json', 
    success : function(data) { 
        alert(data);
    } 
});

/cmdb/ci/building/add.mvc

@RequestMapping("/add")
@ResponseBody
public java.lang.String add(Building building) throws com.otu.core.util.serialize.json.JSONException

参     数:

参数名 类型 描述 是否必须
name string 名称
description string 描述
gc string 楼宇地理坐标
address string 楼宇地址
region.id string 所属区域的id

返 回 值:

  描述 范例
成功 楼宇的明细信息 {
   success : true,  
   root :{  id : xxx,  name :xxx,  region: xxx  ......  }
}
失败 错误信息 {   success : false,    msg : xxx,    code : xxx    }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据解析异常

示例:

$.ajax({
    url : '/ci/building/add.mvc',
    type : 'post',
    data : {
        'name' : 'xxxx',
        'region.id' : 'xxxxx',
        'description' : 'xxxxx',
        'gc' : 'xxxxx',
        'address' : 'xxxxx'
    },
    dataType : 'json',
    success : function(data) {
        alert(data);
    }
});

/cmdb/ci/building/update.mvc

@RequestMapping(value="/update")
@ResponseBody
public java.lang.String update(Building building) throws com.otu.core.util.serialize.json.JSONException

参     数:

参数名 类型 描述 是否必须
id String 修改building的id
name String 名称
region.id String 所属区域id

返 回 值:

  描述 范例
成功 新楼宇的明细信息 {
  success : true,
  root :{  id : xxx,  name :xxx,  region : xxx  }
}
失败 错误信息 {   success : false,   msg : xxx,   code : xxx }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据解析异常

示     例:

$.ajax({
    url : '/cmdb/ci/building/update.mvc',
    type : 'post',
    data : {
        'id' : 'xxxx',
        'name' : 'name',
        'region.id' : 'xxxxxx',
        'description' : 'xxxxx',
        'gc' : 'xxxxx',
        'address' : 'xxxxx'
    },
    dataType : 'json',
    success : function(data) {
        alert(data);
    }
});

/cmdb/ci/building/delete.mvc

@RequestMapping(value="/delete")
@ResponseBody
public java.lang.String delete(java.lang.String id)

参     数:

参数名 类型 描述 是否必须
id String 楼宇id

返 回 值:

  描述 范例
成功 删除成功 {  success : true   }
失败 删除失败 {  success : false    }

异    常:

编号 描述

示例:

$.ajax({
    url : '/cmdb/ci/building/delete.mvc',
    data : {
        'id' : 'xxx'
    },
    dataType : "json",
    success : function(data) {
        alert(data);
    }
});

/cmdb/ci/building/bulkDelete.mvc

批量删除楼宇,若有对象在系统中存在约束不能删除时,回滚全部删除操作

@RequestMapping(value="/bulkDelete")
@ResponseBody
public String bulkDelete(String[] ids)

参     数:

参数名 类型 描述 是否必须
ids String[] 楼宇id数组

返 回 值:

  描述 范例
成功 删除成功 {  success : true   }
失败 删除失败 {  success : false    }

异    常:

编号 描述

示例:

$.ajax({
    url : '/cmdb/ci/building/bulkDelete.mvc',
    data : {
        'ids' : ['xxx1','xxx2']
    },
    dataType : "json",
    success : function(data) {
        alert(data);
    }
});

/cmdb/ci/building/get.mvc

@RequestMapping(value="/get")
@ResponseBody
public java.lang.String get(String id) throws com.otu.core.util.serialize.json.JSONException

参     数:

参数名 类型 描述 是否必须
id String building的id

返 回 值:

  描述 范例
成功 新楼宇的明细信息 {
  success : true,
  root :{  id : xxx,  name :xxx,  region : xxx  }
}
失败 错误信息 {   success : false,   msg : xxx,   code : xxx }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据解析异常

示     例:

$.ajax({
    url : '/cmdb/ci/building/get.mvc',
    type : 'post',
    data : {
        'id' : 'xxxx'
    },
    dataType : 'json',
    success : function(data) {
        alert(data);
    }
});

/cmdb/ci/floor/list.mvc

获取楼层的信息

@RequestMapping(value="/list")
@ResponseBody
public java.lang.String list(@RequestParam Map<String, Object> props, String[] attrs) throws com.otu.core.util.serialize.json.JSONException

参     数:

参数名 类型 描述 是否必须
attrs String 需要显示的属性列表,为空时全部返回
start int 开始索引
limit int 页大小
sortName String 排序属性
sortOrder String 排序顺序,asc | desc, 默认asc(升序)
name String 名称
…… …… 查询参数列表,参数可添加后缀进行复杂匹配,props更多查阅 JAVA API 中Floor的属性
说明:CMDB根据不同的后缀封装查询条件,后缀如下:
  • = : eq
  • > :gt
  • < :lt
  • >= :ge
  • <= : le
  • like :like
  • in :in
  • notIn :notIn
  • notLike :notLike
使用时将属性与后缀以*分割拼接即可,即 属性名称*后缀 : 'xxx',因此接口只返回通用信息,故匹配的属性必须在通用信息中国,还可参考下面的详细示例教程

返 回 值:

  描述 范例
成功 得到楼层数据 {
  success : true,
  total : xxx,
  root :[  {  id : xxx,  name : xxx,  ......  }  ]
}
失败 错误信息 {   success : false,    msg : xxx,    code : xxx    }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据序列化异常

示例:

$.ajax({ 
    url : '/cmdb/ci/floor/list.mvc', 
    type : 'post',
    data : { 
       'attrs' : ['name','building.name','building.id',...] // 不包含此参数表示返回全部信息
       'start' : 0,
       'limit' : 20,
       'sortName' : 'name',    //排序的属性
       'sortOrder' : 'desc'    //升序排序或降序排序,asc|desc,默认为asc(升序排序)
       
       //复杂条件组合,和以上参数区别开来(以下示例参数只做教程说明,并非floor的属性,使用时请注意)
       'name' : 'xxx', // 查询name = xxx 的记录,没有后缀默认为eq
       'name*eq' : 'xxx', // 查询name =xxx 的记录,eq可省略
       'apPortCount*gt' : 'xxx', // 查询apPortCount > xxx 的记录,
       'apPortCount*lt' : 'xxx', // 查询apPortCount < xxx 的记录,
       'apPortCount*ge' : 'xxx', // 查询apPortCount >= xxx 的记录,
       'apPortCount*le' : 'xxx', // 查询apPortCount <= xxx 的记录,
       'apPortCount*like' : 'xxx',    //查询apPortCount like '%xxx%' 的记录, 后台自动封装%
       'apPortCount*notLike' : 'xxx', // 查询去除apPortCount like '%xxx%'的记录,后台自动封装%
       'id*in' : 'xx1,xx2', // 查询id 为'xx1'或'xx2'的记录, id以','分隔
       'id*notIn' : 'xx1,xx2', // 查询id 不为'xx1'和'xx2'的记录, id以','分隔
    }, 
    dataType : 'json', 
    success : function(data) { 
        alert(data);
    } 
});

/cmdb/ci/floor/add.mvc

@RequestMapping("/add")
@ResponseBody
public java.lang.String add(Floor floor) throws com.otu.core.util.serialize.json.JSONException

参     数:

参数名 类型 描述 是否必须
name string 名称
floorNO string 楼层编号
description string 描述
building.id string 所属楼宇的id

返 回 值:

  描述 范例
成功 楼层的明细信息 {
   success : true,  
   root :{  id : xxx,  name :xxx,  building: xxx  ......  }
}
失败 错误信息 {   success : false,    msg : xxx,    code : xxx    }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据解析异常

示例:

$.ajax({
    url : '/cmdb/ci/floor/add.mvc',
    type : 'post',
    data : {
        'name' : 'xxxx',
        'building.id' : 'xxxxx',
        'floorNO' : 'xxxxx',
        'description' : 'xxxxx'
    },
    dataType : 'json',
    success : function(data) {
        alert(data);
    }
});

/cmdb/ci/floor/update.mvc

@RequestMapping(value="/update")
@ResponseBody
public java.lang.String update(Floor floor) throws java.lang.Exception

参     数:

参数名 类型 描述 是否必须
id String 修改floor的id
name String 名称
floorNO string 楼层编号
description string 描述
building.id String 所属楼宇的id

返 回 值:

  描述 范例
成功 新楼层的明细信息 {
  success : true,
  root :{  id : xxx,  name :xxx,  building : xxx  }
}
失败 错误信息 {   success : false,   msg : xxx,   code : xxx }

异    常:

编号 描述
java.lang.Exception

示     例:

    $.ajax({
        url : '/cmdb/ci/floor/update.mvc',
        type : 'post',
        data : {
            'id' : 'xxxx',
            'name' : 'name',
            'building.id' : 'xxxxxx',
	        'floorNO' : 'xxxxx',
	        'description' : 'xxxxx'
        },
        dataType : 'json',
        success : function(data) {
            alert(data);
        }
    });

/cmdb/ci/floor/delete.mvc

@RequestMapping(value="/delete")
@ResponseBody
public java.lang.String delete(java.lang.String id)

参     数:

参数名 类型 描述 是否必须
id String 楼层id

返 回 值:

  描述 范例
成功 删除成功 {  success : true   }
失败 删除失败 {  success : false    }

异    常:

编号 描述

示例:

$.ajax({
    url : '/cmdb/ci/floor/delete.mvc',
    data : {
        'id' : 'xxx',
    },
    dataType : "json",
    success : function(data) {
        alert(data);
    }
});

/cmdb/ci/floor/bulkDelete.mvc

批量删除,若有对象在系统中存在约束不能删除时,则回滚全部删除操作

@RequestMapping(value="/bulkDelete")
@ResponseBody
public String bulkDelete(String[] ids)

参     数:

参数名 类型 描述 是否必须
ids String[] id数组

返 回 值:

  描述 范例
成功 删除成功 {  success : true   }
失败 删除失败 {  success : false    }

异    常:

编号 描述

示例:

$.ajax({
    url : '/cmdb/ci/floor/bulkDelete.mvc',
    data : {
        'ids' : ['xxx1','xxx2']
    },
    dataType : "json",
    success : function(data) {
        alert(data);
    }
});

/cmdb/ci/floor/get.mvc

@RequestMapping(value="/get")
@ResponseBody
public java.lang.String get(String id) throws com.otu.core.util.serialize.json.JSONException

参     数:

参数名 类型 描述 是否必须
id String floor的id

返 回 值:

  描述 范例
成功 楼宇的明细信息 {
  success : true,
  root :{  id : xxx,  name :xxx,  region : xxx  }
}
失败 错误信息 {   success : false,   msg : xxx,   code : xxx }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据解析异常

示     例:

$.ajax({
    url : '/cmdb/ci/floor/get.mvc',
    type : 'post',
    data : {
        'id' : 'xxxx'
    },
    dataType : 'json',
    success : function(data) {
        alert(data);
    }
});

/cmdb/ci/room/list.mvc

获取某个楼层下所有房间的信息

@RequestMapping(value="/list")
@ResponseBody
public java.lang.String list(@RequestParam Map<String, Object> props, String[] attrs) throws com.otu.core.util.serialize.json.JSONException

参     数:

参数名 类型 描述 是否必须
attrs String 需要显示的属性列表,为空时全部返回
start int 开始索引
limit int 页大小
sortName String 排序属性
sortOrder String 排序顺序,asc | desc, 默认asc(升序)
name String 名称
…… …… 查询参数列表,参数可添加后缀进行复杂匹配,props更多查阅 JAVA API 中Floor的属性

返 回 值:

  描述 范例
成功 得到房间数据 {
  success : true,
  total : xxx,
  root :[  {  id : xxx,  name : xxx,  ......  }  ]
}
失败 错误信息 {   success : false,    msg : xxx,    code : xxx    }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据序列化异常

示例:

    $.ajax({ 
        url : '/cmdb/ci/room/list.mvc', 
	    type : 'post',
	    data : { 
	       'attrs' : ['name','floor.name','floor.id',...] // 不包含此参数表示返回全部信息
	       'start' : 0,
	       'limit' : 20,
	       'sortName' : 'name',    //排序的属性
	       'sortOrder' : 'desc'    //升序排序或降序排序,asc|desc,默认为asc(升序排序)
	       
	       //复杂条件组合,和以上参数区别开来(以下示例参数只做教程说明,并非floor的属性,使用时请注意)
	       'name' : 'xxx', // 查询name = xxx 的记录,没有后缀默认为eq
	       'name*eq' : 'xxx', // 查询name =xxx 的记录,eq可省略
	       'apPortCount*gt' : 'xxx', // 查询apPortCount > xxx 的记录,
	       'apPortCount*lt' : 'xxx', // 查询apPortCount < xxx 的记录,
	       'apPortCount*ge' : 'xxx', // 查询apPortCount >= xxx 的记录,
	       'apPortCount*le' : 'xxx', // 查询apPortCount <= xxx 的记录,
	       'apPortCount*like' : 'xxx',    //查询apPortCount like '%xxx%' 的记录, 后台自动封装%
	       'apPortCount*notLike' : 'xxx', // 查询去除apPortCount like '%xxx%'的记录,后台自动封装%
	       'id*in' : 'xx1,xx2', // 查询id 为'xx1'或'xx2'的记录, id以','分隔
	       'id*notIn' : 'xx1,xx2', // 查询id 不为'xx1'和'xx2'的记录, id以','分隔
	    }, 
	    dataType : 'json', 
	    success : function(data) { 
	        alert(data);
	    } 
    });
                

/cmdb/ci/room/add.mvc

@RequestMapping("/add")
@ResponseBody
public java.lang.String add(Room room) throws com.otu.core.util.serialize.json.JSONException

参     数:

参数名 类型 描述 是否必须
name string 名称
roomNO string 房间编号
description string 描述
floor.id string 所属楼层的id

返 回 值:

  描述 范例
成功 房间的明细信息 {
   success : true,  
   root :{  id : xxx,  name :xxx,  floor: xxx  ......  }
}
失败 错误信息 {   success : false,    msg : xxx,    code : xxx    }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据解析异常

示例:

                $.ajax({
                    url : '/cmdb/ci/room/add.mvc',
                    type : 'post',
                    data : {
                        'name' : 'xxxx',
                        'floor.id' : 'xxxxx'
			            'roomNo' : 'xxxx',
			            'description' : 'xxxx'
                    },
                    dataType : 'json',
                    success : function(data) {
                        alert(data);
                    }
                });
                

/cmdb/ci/room/update.mvc

@RequestMapping(value="/update")
@ResponseBody
public java.lang.String update(Floor floor) throws java.lang.Exception

参     数:

参数名 类型 描述 是否必须
id String id
floorNO string 楼层编号
description string 描述
name String 名称
floor.id String 所属楼层的id

返 回 值:

  描述 范例
成功 新房间的明细信息 {
  success : true,
  root :{  id : xxx,  name :xxx,  floor : xxx  }
}
失败 错误信息 {   success : false,   msg : xxx,   code : xxx }

异    常:

编号 描述
java.lang.Exception

示     例:

    $.ajax({
        url : '/cmdb/ci/room/update.mvc',
        type : 'post',
        data : {
            'id' : 'xxxx',
            'name' : 'name',
            'floor.id' : 'xxxxxx',
            'roomNo' : 'xxxx',
            'description' : 'xxxx'
        },
        dataType : 'json',
        success : function(data) {
            alert(data);
        }
    });
            

/cmdb/ci/room/delete.mvc

@RequestMapping(value="/delete")
@ResponseBody
public java.lang.String delete(java.lang.String id)

参     数:

参数名 类型 描述 是否必须
id String 房间的id

返 回 值:

  描述 范例
成功 删除成功 {  success : true   }
失败 删除失败 {  success : false    }

异    常:

编号 描述

示例:

    $.ajax({
        url : '/cmdb/ci/room/delete.mvc',
        data : {
            'id' : 'xxx',
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });
                

/cmdb/ci/room/bulkDelete.mvc

批量删除,若有对象在系统中存在约束不能删除时,则回滚全部删除操作

@RequestMapping(value="/bulkDelete")
@ResponseBody
public java.lang.String bulkDelete(java.lang.String[] ids)

参     数:

参数名 类型 描述 是否必须
ids String[] 房间的id数组

返 回 值:

  描述 范例
成功 删除成功 {  success : true   }
失败 删除失败 {  success : false    }

异    常:

编号 描述

示例:

    $.ajax({
        url : '/cmdb/ci/room/bulkDelete.mvc',
        data : {
            'ids' : ['xxx', 'xxx']
        },
        dataType : "json",
        success : function(data) {
            alert(data);
        }
    });
                

/cmdb/ci/room/get.mvc

@RequestMapping(value="/get")
@ResponseBody
public java.lang.String get(String id) throws com.otu.core.util.serialize.json.JSONException

参     数:

参数名 类型 描述 是否必须
id String room的id

返 回 值:

  描述 范例
成功 房间的明细信息 {
  success : true,
  root :{  id : xxx,  name :xxx,  region : xxx  }
}
失败 错误信息 {   success : false,   msg : xxx,   code : xxx }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据解析异常

示     例:

$.ajax({
    url : '/cmdb/ci/room/get.mvc',
    type : 'post',
    data : {
        'id' : 'xxxx'
    },
    dataType : 'json',
    success : function(data) {
        alert(data);
    }
});

/cmdb/ci/impact/list.mvc

@RequestMapping("/list")
@ResponseBody
public String list(@RequestParam Map<String, Object> props, String[] attrs) throws JSONException

参     数:

参数名 类型 描述 是否必须
attrs String 需要显示的属性列表,为空时全部返回
start int 开始索引
limit int 页大小
sortName String 排序属性
sortOrder String 排序顺序,asc | desc, 默认asc(升序)
name String 名称
code String 编码
description String 描述
factors String 规则因素
…… …… 查询参数列表,参数可添加后缀进行复杂匹配,props更多查阅 JAVA API 中Impact的属性
说明:CMDB根据不同的后缀封装查询条件,后缀如下:
  • = : eq
  • > :gt
  • < :lt
  • >= :ge
  • <= : le
  • like :like
  • in :in
  • notIn :notIn
  • notLike :notLike
使用时将属性与后缀以*分割拼接即可,即 属性名称*后缀 : 'xxx',因此接口只返回通用信息,故匹配的属性必须在通用信息中国,还可参考下面的详细示例教程

返 回 值:

  描述 范例
成功 得到严重级数据 {
  success : true,
  total : xxx,
  root :[  {  id : xxx,  name : xxx,  ......  }  ]
}
失败 错误信息 {   success : false,    msg : xxx,    code : xxx    }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据序列化异常

示例:

$.ajax({ 
    url : '/cmdb/ci/impact/list.mvc', 
    type : 'post',
    data : { 
       'attrs' : ['name','code',...] // 不包含此参数表示返回全部信息
       'start' : 0,
       'limit' : 20,
       'sortName' : 'name',    //排序的属性
       'sortOrder' : 'desc'    //升序排序或降序排序,asc|desc,默认为asc(升序排序)
       
       //复杂条件组合,和以上参数区别开来(以下示例参数只做教程说明,并非impact的属性,使用时请注意)
       'name' : 'xxx', // 查询name = xxx 的记录,没有后缀默认为eq
       'name*eq' : 'xxx', // 查询name =xxx 的记录,eq可省略
       'apPortCount*gt' : 'xxx', // 查询apPortCount > xxx 的记录,
       'apPortCount*lt' : 'xxx', // 查询apPortCount < xxx 的记录,
       'apPortCount*ge' : 'xxx', // 查询apPortCount >= xxx 的记录,
       'apPortCount*le' : 'xxx', // 查询apPortCount <= xxx 的记录,
       'apPortCount*like' : 'xxx',    //查询apPortCount like '%xxx%' 的记录, 后台自动封装%
       'apPortCount*notLike' : 'xxx', // 查询去除apPortCount like '%xxx%'的记录,后台自动封装%
       'id*in' : 'xx1,xx2', // 查询id 为'xx1'或'xx2'的记录, id以','分隔
       'id*notIn' : 'xx1,xx2', // 查询id 不为'xx1'和'xx2'的记录, id以','分隔
    }, 
    dataType : 'json', 
    success : function(data) { 
        alert(data);
    } 
});

/cmdb/ci/impact/add.mvc

@RequestMapping("/add")
@ResponseBody
public java.lang.String add(Impact impact) throws com.otu.core.util.serialize.json.JSONException

参     数:

参数名 类型 描述 是否必须
name string 名称
code string 编码

返 回 值:

  描述 范例
成功 严重级别的明细信息 {
   success : true,  
   root :{  id : xxx,  name :xxx,  ......  }
}
失败 错误信息 {   success : false,    msg : xxx,    code : xxx    }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据解析异常

示例:

$.ajax({
    url : '/ci/impact/add.mvc',
    type : 'post',
    data : {
        'name' : 'xxxx',
        'code' : 'xxxxx'
    },
    dataType : 'json',
    success : function(data) {
        alert(data);
    }
});

/cmdb/ci/impact/update.mvc

@RequestMapping(value="/update")
@ResponseBody
public java.lang.String update(Impact impact) throws com.otu.core.util.serialize.json.JSONException

参     数:

参数名 类型 描述 是否必须
id String id
code String 编码
name String 名称

返 回 值:

  描述 范例
成功 明细信息 {
  success : true,
  root :{  id : xxx,  name :xxx  }
}
失败 错误信息 {   success : false,   msg : xxx,   code : xxx }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据解析异常

示     例:

$.ajax({
    url : '/cmdb/ci/impact/update.mvc',
    type : 'post',
    data : {
        'id' : 'xxxx',
        'name' : 'name',
        'code' : 'xxxxxx'
    },
    dataType : 'json',
    success : function(data) {
        alert(data);
    }
});

/cmdb/ci/impact/delete.mvc

@RequestMapping(value="/delete")
@ResponseBody
public java.lang.String delete(java.lang.String id)

参     数:

参数名 类型 描述 是否必须
id String id

返 回 值:

  描述 范例
成功 删除成功 {  success : true   }
失败 删除失败 {  success : false    }

异    常:

编号 描述

示例:

$.ajax({
    url : '/cmdb/ci/impact/delete.mvc',
    data : {
        'id' : 'xxx'
    },
    dataType : "json",
    success : function(data) {
        alert(data);
    }
});

/cmdb/ci/impact/bulkDelete.mvc

批量删除,若有对象在系统中存在约束不能删除时,回滚全部删除操作

@RequestMapping(value="/bulkDelete")
@ResponseBody
public String bulkDelete(String[] ids)

参     数:

参数名 类型 描述 是否必须
ids String[] id数组

返 回 值:

  描述 范例
成功 删除成功 {  success : true   }
失败 删除失败 {  success : false    }

异    常:

编号 描述

示例:

$.ajax({
    url : '/cmdb/ci/impact/bulkDelete.mvc',
    data : {
        'ids' : ['xxx1','xxx2']
    },
    dataType : "json",
    success : function(data) {
        alert(data);
    }
});

/cmdb/ci/impact/get.mvc

@RequestMapping(value="/get")
@ResponseBody
public java.lang.String get(String id) throws com.otu.core.util.serialize.json.JSONException

参     数:

参数名 类型 描述 是否必须
id String impact的id

返 回 值:

  描述 范例
成功 严重级别明细信息 {
  success : true,
  root :{  id : xxx,  name :xxx,  region : xxx  }
}
失败 错误信息 {   success : false,   msg : xxx,   code : xxx }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据解析异常

示     例:

$.ajax({
    url : '/cmdb/ci/impact/get.mvc',
    type : 'post',
    data : {
        'id' : 'xxxx'
    },
    dataType : 'json',
    success : function(data) {
        alert(data);
    }
});

/cmdb/ci/priority/list.mvc

@RequestMapping("/list")
@ResponseBody
public String list(@RequestParam Map<String, Object> props, String[] attrs) throws JSONException

参     数:

参数名 类型 描述 是否必须
attrs String 需要显示的属性列表,为空时全部返回
start int 开始索引
limit int 页大小
sortName String 排序属性
sortOrder String 排序顺序,asc | desc, 默认asc(升序)
name String 名称
code String 编码
description String 描述
isDefault boolean 是默认级别
color String 颜色
icon String 图标
slaProgram String 服务级别方案
…… …… 查询参数列表,参数可添加后缀进行复杂匹配,props更多查阅 JAVA API 中Priority的属性
说明:CMDB根据不同的后缀封装查询条件,后缀如下:
  • = : eq
  • > :gt
  • < :lt
  • >= :ge
  • <= : le
  • like :like
  • in :in
  • notIn :notIn
  • notLike :notLike
使用时将属性与后缀以*分割拼接即可,即 属性名称*后缀 : 'xxx',因此接口只返回通用信息,故匹配的属性必须在通用信息中国,还可参考下面的详细示例教程

返 回 值:

  描述 范例
成功 得到楼宇数据 {
  success : true,
  total : xxx,
  root :[  {  id : xxx,  name : xxx,  ......  }  ]
}
失败 错误信息 {   success : false,    msg : xxx,    code : xxx    }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据序列化异常

示例:

$.ajax({ 
    url : '/cmdb/ci/priority/list.mvc', 
    type : 'post',
    data : { 
       'attrs' : ['name','code',...] // 不包含此参数表示返回全部信息
       'start' : 0,
       'limit' : 20,
       'sortName' : 'name',    //排序的属性
       'sortOrder' : 'desc'    //升序排序或降序排序,asc|desc,默认为asc(升序排序)
       
       //复杂条件组合,和以上参数区别开来(以下示例参数只做教程说明,并非priority的属性,使用时请注意)
       'name' : 'xxx', // 查询name = xxx 的记录,没有后缀默认为eq
       'name*eq' : 'xxx', // 查询name =xxx 的记录,eq可省略
       'apPortCount*gt' : 'xxx', // 查询apPortCount > xxx 的记录,
       'apPortCount*lt' : 'xxx', // 查询apPortCount < xxx 的记录,
       'apPortCount*ge' : 'xxx', // 查询apPortCount >= xxx 的记录,
       'apPortCount*le' : 'xxx', // 查询apPortCount <= xxx 的记录,
       'apPortCount*like' : 'xxx',    //查询apPortCount like '%xxx%' 的记录, 后台自动封装%
       'apPortCount*notLike' : 'xxx', // 查询去除apPortCount like '%xxx%'的记录,后台自动封装%
       'id*in' : 'xx1,xx2', // 查询id 为'xx1'或'xx2'的记录, id以','分隔
       'id*notIn' : 'xx1,xx2', // 查询id 不为'xx1'和'xx2'的记录, id以','分隔
    }, 
    dataType : 'json', 
    success : function(data) { 
        alert(data);
    } 
});

/cmdb/ci/priority/add.mvc

@RequestMapping("/add")
@ResponseBody
public java.lang.String add(Priority priority) throws com.otu.core.util.serialize.json.JSONException

参     数:

参数名 类型 描述 是否必须
name string 名称
code string 编码
description String 描述
isDefault boolean 是默认级别
color String 颜色
icon String 图标
slaProgram String 服务级别方案

返 回 值:

  描述 范例
成功 优先级的明细信息 {
   success : true,  
   root :{  id : xxx,  name :xxx,  ......  }
}
失败 错误信息 {   success : false,    msg : xxx,    code : xxx    }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据解析异常

示例:

$.ajax({
    url : '/ci/priority/add.mvc',
    type : 'post',
    data : {
        'name' : 'xxxx',
        'code' : 'xxxxx'
    },
    dataType : 'json',
    success : function(data) {
        alert(data);
    }
});

/cmdb/ci/priority/update.mvc

@RequestMapping(value="/update")
@ResponseBody
public java.lang.String update(Priority priority) throws com.otu.core.util.serialize.json.JSONException

参     数:

参数名 类型 描述 是否必须
id String id
name String 名称
code String 编码
description String 描述
isDefault boolean 是默认级别
color String 颜色
icon String 图标
slaProgram String 服务级别方案

返 回 值:

  描述 范例
成功 明细信息 {
  success : true,
  root :{  id : xxx,  name :xxx  }
}
失败 错误信息 {   success : false,   msg : xxx,   code : xxx }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据解析异常

示     例:

$.ajax({
    url : '/cmdb/ci/priority/update.mvc',
    type : 'post',
    data : {
        'id' : 'xxxx',
        'name' : 'name',
        'code' : 'xxxxxx'
    },
    dataType : 'json',
    success : function(data) {
        alert(data);
    }
});

/cmdb/ci/priority/delete.mvc

@RequestMapping(value="/delete")
@ResponseBody
public java.lang.String delete(java.lang.String id)

参     数:

参数名 类型 描述 是否必须
id String id

返 回 值:

  描述 范例
成功 删除成功 {  success : true   }
失败 删除失败 {  success : false    }

异    常:

编号 描述

示例:

$.ajax({
    url : '/cmdb/ci/priority/delete.mvc',
    data : {
        'id' : 'xxx'
    },
    dataType : "json",
    success : function(data) {
        alert(data);
    }
});

/cmdb/ci/priority/bulkDelete.mvc

批量删除,若有对象在系统中存在约束不能删除时,回滚全部删除操作

@RequestMapping(value="/bulkDelete")
@ResponseBody
public String bulkDelete(String[] ids)

参     数:

参数名 类型 描述 是否必须
ids String[] id数组

返 回 值:

  描述 范例
成功 删除成功 {  success : true   }
失败 删除失败 {  success : false    }

异    常:

编号 描述

示例:

$.ajax({
    url : '/cmdb/ci/priority/bulkDelete.mvc',
    data : {
        'ids' : ['xxx1','xxx2']
    },
    dataType : "json",
    success : function(data) {
        alert(data);
    }
});

/cmdb/ci/priority/get.mvc

@RequestMapping(value="/get")
@ResponseBody
public java.lang.String get(String id) throws com.otu.core.util.serialize.json.JSONException

参     数:

参数名 类型 描述 是否必须
id String priority的id

返 回 值:

  描述 范例
成功 优先级明细信息 {
  success : true,
  root :{  id : xxx,  name :xxx,  region : xxx  }
}
失败 错误信息 {   success : false,   msg : xxx,   code : xxx }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据解析异常

示     例:

$.ajax({
    url : '/cmdb/ci/priority/get.mvc',
    type : 'post',
    data : {
        'id' : 'xxxx'
    },
    dataType : 'json',
    success : function(data) {
        alert(data);
    }
});

/cmdb/ci/impactAndUrgency/createImpactAndUrgency.mvc

@RequestMapping("createImpactAndUrgency")
@ResponseBody
public java.lang.String createImpactAndUrgency(String impactId, String urgencyId, String priorityId)

参     数:

参数名 类型 描述 是否必须
impactId string 影响级别id
urgencyId string 紧急级别id
priorityId String 优先级别id

返 回 值:

  描述 范例
成功 优先级的明细信息 {
   success : true  
}
失败 错误信息 {   success : false,    msg : xxx,    code : xxx    }

异    常:

编号 描述

示例:

$.ajax({
    url : '/cmdb/ci/impactAndUrgency/createImpactAndUrgency.mvc',
    type : 'post',
    data : {
        'impactId' : 'xxxx',
        'urgencyId' : 'xxxxx',
        'priorityId' : 'xxxxx'
    },
    dataType : 'json',
    success : function(data) {
        alert(data);
    }
});

/cmdb/ci/impactAndUrgency/saveImpactAndUrgency.mvc

@RequestMapping("saveImpactAndUrgency")
@ResponseBody
public java.lang.String saveImpactAndUrgency(String id, String impactId, String urgencyId, String priorityId)

参     数:

参数名 类型 描述 是否必须
id string 优先级矩阵id
impactId string 影响级别id
urgencyId string 紧急级别id
priorityId String 优先级别id

返 回 值:

  描述 范例
成功 优先级的明细信息 {
   success : true  
}
失败 错误信息 {   success : false,    msg : xxx,    code : xxx    }

异    常:

编号 描述

示例:

$.ajax({
    url : '/cmdb/ci/impactAndUrgency/saveImpactAndUrgency.mvc',
    type : 'post',
    data : {
        'id' : 'xxxx',
        'impactId' : 'xxxx',
        'urgencyId' : 'xxxxx',
        'priorityId' : 'xxxxx'
    },
    dataType : 'json',
    success : function(data) {
        alert(data);
    }
});

/cmdb/ci/impactAndUrgency/getImpactAndUrgency.mvc

@RequestMapping("getImpactAndUrgency")
@ResponseBody
public java.lang.String getImpactAndUrgency(String impactId, String urgencyId)

参     数:

参数名 类型 描述 是否必须
impactId string 影响级别id
urgencyId string 紧急级别id

返 回 值:

  描述 范例
成功 优先级的明细信息 {
   success : true  
}
失败 错误信息 {   success : false    }

异    常:

编号 描述

示例:

$.ajax({
    url : '/cmdb/ci/impactAndUrgency/getImpactAndUrgency.mvc',
    type : 'post',
    data : {
        'impactId' : 'xxxx',
        'urgencyId' : 'xxxxx'
    },
    dataType : 'json',
    success : function(data) {
        alert(data);
    }
});

/cmdb/ci/impactAndUrgency/getImpactAndUrgencyTable.mvc

@RequestMapping("getImpactAndUrgencyTable")
@ResponseBody
public java.lang.String getImpactAndUrgencyTable()

参     数:

参数名 类型 描述 是否必须

返 回 值:

  描述 范例
成功 优先级的明细信息 {
   topHead : {'影响程度', '优先级' , '紧急程度'}  
   head : {},
   body : {},
   bodyValue : {}
}
失败 错误信息 {   success : false    }

异    常:

编号 描述

示例:

$.ajax({
    url : '/cmdb/ci/impactAndUrgency/getImpactAndUrgencyTable.mvc',
    type : 'post',
    dataType : 'json',
    success : function(data) {
        alert(data);
    }
});

/cmdb/ci/impactAndUrgency/getImpactAndUrgencyList.mvc

@RequestMapping("getImpactAndUrgencyList")
@ResponseBody
public java.lang.String getImpactAndUrgencyList(HttpServletRequest request)

参     数:

参数名 类型 描述 是否必须

返 回 值:

  描述 范例
成功 优先级的明细信息 {
   success : true  
   total : xx,
   root : []
}
失败 错误信息 {   success : false    }

异    常:

编号 描述

示例:

$.ajax({
    url : '/cmdb/ci/impactAndUrgency/getImpactAndUrgencyList.mvc',
    type : 'post',
    data : {
        'priorityId' : 'xxxx'
    },
    dataType : 'json',
    success : function(data) {
        alert(data);
    }
});

/cmdb/ci/impactAndUrgency/checkRepeatValue.mvc

@RequestMapping("checkRepeatValue")
@ResponseBody
public java.lang.String checkRepeatValue(String id, String className, String name, String value)

参     数:

参数名 类型 描述 是否必须
id String 检查记录的id
className String 检查记录的实体模型类名
name String 检查的字段名
value String 检查的字符串

返 回 值:

  描述 范例
成功 优先级的明细信息 {
   success : true  
   repeat : true | false
}
失败 错误信息 {   success : false    }

异    常:

编号 描述

示例:

$.ajax({
    url : '/cmdb/ci/impactAndUrgency/checkRepeatValue.mvc',
    type : 'post',
    data : {
        'id' : 'xxxx',
        'className' : 'xxxx',
        'name' : 'xxxx',
        'value' : 'xxxx'
    },
    dataType : 'json',
    success : function(data) {
        alert(data);
    }
});

/cmdb/ci/urgency/list.mvc

@RequestMapping("/list")
@ResponseBody
public String list(@RequestParam Map<String, Object> props, String[] attrs) throws JSONException

参     数:

参数名 类型 描述 是否必须
attrs String 需要显示的属性列表,为空时全部返回
start int 开始索引
limit int 页大小
sortName String 排序属性
sortOrder String 排序顺序,asc | desc, 默认asc(升序)
name String 名称
code String 编码
description String 描述
factors String 规则因素
…… …… 查询参数列表,参数可添加后缀进行复杂匹配,props更多查阅 JAVA API 中Urgency的属性
说明:CMDB根据不同的后缀封装查询条件,后缀如下:
  • = : eq
  • > :gt
  • < :lt
  • >= :ge
  • <= : le
  • like :like
  • in :in
  • notIn :notIn
  • notLike :notLike
使用时将属性与后缀以*分割拼接即可,即 属性名称*后缀 : 'xxx',因此接口只返回通用信息,故匹配的属性必须在通用信息中国,还可参考下面的详细示例教程

返 回 值:

  描述 范例
成功 得到urgency数据 {
  success : true,
  total : xxx,
  root :[  {  id : xxx,  name : xxx,  ......  }  ]
}
失败 错误信息 {   success : false,    msg : xxx,    code : xxx    }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据序列化异常

示例:

$.ajax({ 
    url : '/cmdb/ci/urgency/list.mvc', 
    type : 'post',
    data : { 
       'attrs' : ['name','code',...] // 不包含此参数表示返回全部信息
       'start' : 0,
       'limit' : 20,
       'sortName' : 'name',    //排序的属性
       'sortOrder' : 'desc'    //升序排序或降序排序,asc|desc,默认为asc(升序排序)
       
       //复杂条件组合,和以上参数区别开来(以下示例参数只做教程说明,并非Urgency的属性,使用时请注意)
       'name' : 'xxx', // 查询name = xxx 的记录,没有后缀默认为eq
       'name*eq' : 'xxx', // 查询name =xxx 的记录,eq可省略
       'apPortCount*gt' : 'xxx', // 查询apPortCount > xxx 的记录,
       'apPortCount*lt' : 'xxx', // 查询apPortCount < xxx 的记录,
       'apPortCount*ge' : 'xxx', // 查询apPortCount >= xxx 的记录,
       'apPortCount*le' : 'xxx', // 查询apPortCount <= xxx 的记录,
       'apPortCount*like' : 'xxx',    //查询apPortCount like '%xxx%' 的记录, 后台自动封装%
       'apPortCount*notLike' : 'xxx', // 查询去除apPortCount like '%xxx%'的记录,后台自动封装%
       'id*in' : 'xx1,xx2', // 查询id 为'xx1'或'xx2'的记录, id以','分隔
       'id*notIn' : 'xx1,xx2', // 查询id 不为'xx1'和'xx2'的记录, id以','分隔
    }, 
    dataType : 'json', 
    success : function(data) { 
        alert(data);
    } 
});

/cmdb/ci/urgency/add.mvc

@RequestMapping("/add")
@ResponseBody
public java.lang.String add(Urgency urgency) throws com.otu.core.util.serialize.json.JSONException

参     数:

参数名 类型 描述 是否必须
name string 名称
code string 编码
description String 描述
factors String 规则因素

返 回 值:

  描述 范例
成功 紧急级别明细信息 {
   success : true,  
   root :{  id : xxx,  name :xxx,  ......  }
}
失败 错误信息 {   success : false,    msg : xxx,    code : xxx    }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据解析异常

示例:

$.ajax({
    url : '/ci/urgency/add.mvc',
    type : 'post',
    data : {
        'name' : 'xxxx',
        'code' : 'xxxxx'
    },
    dataType : 'json',
    success : function(data) {
        alert(data);
    }
});

/cmdb/ci/urgency/update.mvc

@RequestMapping(value="/update")
@ResponseBody
public java.lang.String update(Urgency urgency) throws com.otu.core.util.serialize.json.JSONException

参     数:

参数名 类型 描述 是否必须
id String id
name String 名称
code String 编码
description String 描述
factors String 规则因素

返 回 值:

  描述 范例
成功 明细信息 {
  success : true,
  root :{  id : xxx,  name :xxx  }
}
失败 错误信息 {   success : false,   msg : xxx,   code : xxx }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据解析异常

示     例:

$.ajax({
    url : '/cmdb/ci/urgency/update.mvc',
    type : 'post',
    data : {
        'id' : 'xxxx',
        'name' : 'name',
        'code' : 'xxxxxx',
    },
    dataType : 'json',
    success : function(data) {
        alert(data);
    }
});

/cmdb/ci/urgency/delete.mvc

@RequestMapping(value="/delete")
@ResponseBody
public java.lang.String delete(java.lang.String id)

参     数:

参数名 类型 描述 是否必须
id String id

返 回 值:

  描述 范例
成功 删除成功 {  success : true   }
失败 删除失败 {  success : false    }

异    常:

编号 描述

示例:

$.ajax({
    url : '/cmdb/ci/urgency/delete.mvc',
    data : {
        'id' : 'xxx'
    },
    dataType : "json",
    success : function(data) {
        alert(data);
    }
});

/cmdb/ci/urgency/bulkDelete.mvc

批量删除,若有对象在系统中存在约束不能删除时,回滚全部删除操作

@RequestMapping(value="/bulkDelete")
@ResponseBody
public String bulkDelete(String[] ids)

参     数:

参数名 类型 描述 是否必须
ids String[] id数组

返 回 值:

  描述 范例
成功 删除成功 {  success : true   }
失败 删除失败 {  success : false    }

异    常:

编号 描述

示例:

$.ajax({
    url : '/cmdb/ci/urgency/bulkDelete.mvc',
    data : {
        'ids' : ['xxx1','xxx2']
    },
    dataType : "json",
    success : function(data) {
        alert(data);
    }
});

/cmdb/ci/urgency/get.mvc

@RequestMapping(value="/get")
@ResponseBody
public java.lang.String get(String id) throws com.otu.core.util.serialize.json.JSONException

参     数:

参数名 类型 描述 是否必须
id String urgency的id

返 回 值:

  描述 范例
成功 优先级明细信息 {
  success : true,
  root :{  id : xxx,  name :xxx,  region : xxx  }
}
失败 错误信息 {   success : false,   msg : xxx,   code : xxx }

异    常:

编号 描述
com.otu.core.util.serialize.json.JSONException 数据解析异常

示     例:

$.ajax({
    url : '/cmdb/ci/urgency/get.mvc',
    type : 'post',
    data : {
        'id' : 'xxxx'
    },
    dataType : 'json',
    success : function(data) {
        alert(data);
    }
});

获取配置项的图标素材库中的全部图片

建设中……