alarm_api.md 4.4 KB

报警系统接口文档

系统接口

(注:condition 为 query,create,update,delete)

(注:为了读写分离,serviceid还会变动,请不要写死)

(注:userId、groupCode、projectId必须传值,appId可以为空)

请求方法:POST

查询

通用查询

报警条目(注:condition 为 query)

请求路径:/alarm/item/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id

请求参数:

查询字段:
{
  "id": "1",
  "code": "1033",
  "name": "测试报警",
  "category": "消防报警",
  "level": "S",
  "condition": {}, //额外写文档
  "remark": "测试数据",
  "dealFun": "test_deal_fun",
  "createUser": "test",
  "createTime": 1602962584000,
  "updateUser": "test",
  "updateTime": 1602962586000,
  "valid": 1
}

报警匹配规则(注:condition 为 query,create,update,delete)

请求路径:/alarm/target/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id

请求参数:

查询字段:
{
  "id": "1",
  "itemCode": "1033",
  "classCode": "OBJ_AX_CODE",
  "condition": {}, //额外写文档
  "createUser": "test",
  "createTime": 1602963135000,
  "updateUser": "test",
  "updateTime": 1602963138000,
  "valid": 1
}
新增:
{
  "itemCode": "1033",
  "classCode": "OBJ_AX_CODE",
  "condition": {}, //额外写文档
  "valid": 1
}
更新:
{
  "id": "1",
  "itemCode": "1033",
  "classCode": "OBJ_AX_CODE",
  "condition": {}, //额外写文档
  "valid": 1
}
删除:
{
  "id": "1"
}

报警定义(注:condition 为 query,update)

请求路径:/alarm/config/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id

请求参数:

查询字段:
{
  "id": "1",
  "objId": "OBJ_1",
  "projectId": "PRJ_WD_001",
  "itemCode": "1033",
  "category": "消防报警",
  "level": "S",
  "condition": {} //额外写文档
  "remark": "测试数据",
  "open": 1,
  "concern": 1,
  "userDefined": 1,
  "createUser": "test",
  "createTime": 1602962781000,
  "updateUser": "test",
  "updateTime": 1602962783000,
  "valid": 1
}
更新:
{
  "id": "1",
  "objId": "OBJ_1",
  "projectId": "PRJ_WD_001",
  "itemCode": "1033",
  "category": "消防报警",
  "level": "S",
  "condition": {}, //额外写文档
  "remark": "测试数据",
  "open": 1,
  "concern": 1,
  "userDefined": 1,
  "valid": 1
}

报警记录(注:condition 为 query,create,update)

请求路径:/alarm/record/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id

请求参数:

查询字段:
{
  "id": "1",
  "itemCode": "1033",
  "projectId": "PRJ_WD_001",
  "objId": "OBJ_1",
  "level": "S",
  "remark": "测试数据",
  "name": '报警名称',
  "category": '报警分类',
  "concern": 1,
  "state": "报警状态",
  "effect_start_time": 1602953256000 ,
  "effect_end_time": 1602953256000 ,
  "createUser": "test",
  "createTime": 1602953249000,
  "updateUser": "test",
  "updateTime": 1602953256000,
  "valid": 1
}
新增:
{
  "itemCode": "1033",
  "projectId": "PRJ_WD_001",
  "objId": "OBJ_1",
  "level": "S",
  "remark": "测试数据",
  "name": '报警名称',
  "category": '报警分类',
  "concern": 1,
  "state": "报警状态",
  "effect_start_time": 1602953256000,
  "effect_end_time": 1602953256000
}
更新:
{
  "id": "1",
  "remark": "测试数据",
  "name": '报警名称',
  "state": "报警状态"
}

####报警日志(注:condition 为 query,create)

请求路径:/alarm/log/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id

请求参数:

查询字段:
{
  "id": "1",
  "record_id": "1033",
  "type": "报警类型",
  "remark": "备注",
  "create_time": 1602953249000,
  "update_time": 1602953249000,
  "valid": 1
}
新增:
{
  "record_id": "1033",
  "type": "报警类型",
  "remark": "备注"
}

####

报警批注(注:condition 为 query,create)

请求路径:/alarm/comment/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id

请求参数:

查询字段:
{
  "id": "1",
  "record_id": "1033",
  "content": "PRJ_WD_001",
  "createUser": "TEST",
  "createTime": 1602953249000,
  "updateTime": 1602953249000,
  "updateUser": "TEST",
  "valid": 1
}
新增:
{
  "record_id": "1033",
  "content": "内容"
}

####