• 快速入门
  • HTTP文档
  • .NET开发指南
  • DEMO下载
  • 调用HTTP常见问题
    Show / Hide Table of Contents
    • 登录接口
      • 名词解释
      • 用户登录
      • 重新登录
    • 写值流程
      • 新增FBox分组
      • FBox新增
      • 新增监控点分组
      • 新增数据监控点
      • FBox列表获取
      • FBox监控点列表
      • 监控点值写入
      • 获取监控点值
    • 获取信息接口
      • 获取单个盒子
      • 获取监控点分组
      • 获取某些监控点
      • 根据监控点分组获取监控点
      • 获取物联网卡Iccid、Imei
      • 获取盒子地理位置
    • 远程下载
      • 获取FBox驱动列表
      • 下载盒子驱动
      • 获取连接设备的寄存器类型
      • 获取服务器驱动列表
    • 盒子修改接口
      • 修改FBox分组
      • FBox名称修改
      • 修改数据监控点
      • 修改省流量模式刷新间隔
    • 盒子删除接口
      • 删除FBox分组
      • FBox删除
      • 删除监控点分组
      • 删除数据监控点
    • 报警接口
      • 报警分组接口
        • 获取报警分组列表
        • 新增报警分组
        • 修改报警分组
        • 删除报警分组
      • 报警联系人接口
        • 获取报警联系人列表
        • 获取单个报警联系人
        • 新增报警联系人
        • 修改报警联系人
        • 删除报警联系人
      • 报警记录接口
        • 获取报警条目列表
        • 获取某些报警条目
        • 新增报警条目
        • 修改报警条目
        • 删除报警条目
        • 获取报警历史
        • 获取报警条目状态
        • 确认报警
    • 历史记录接口
      • 获取历史记录条目
      • 获取某些历史记录条目
      • 新增历史记录
      • 更新历史记录
      • 删除历史记录
      • 获取历史记录数据
    • 监控点推送控制接口
      • 开启某监控点组别
      • 停止某监控点组别
      • 开启监控点组别列表
      • 停止监控点组别列表
      • 开启FBox所有监控点
      • 停止FBox所有监控点
      • 开启某条监控点
      • 停止某条监控点
      • 开启某些监控点
      • 停止某些监控点
      • 只开启某些监控点
      • 只开启某监控点组
      • 只开启某些监控点组
    • 数据推送(SignalR)
      • 实时数据推送(signalR)
      • FBox状态变更推送
      • 实时数据推送
      • 报警触发推送
      • 报警还原推送
    • 统一写值
      • 获取所有统一写分组
      • 统一写分组值写入
    • 附录
      • 附录一
      • 附录二
      • 附录三
      • 429状态码

    新增报警条目

    • 功能描述

      该接口用于用户新增报警条目

    • 请求地址

      旧版:(二选一)

      URL1:[apiBaseUrl]v2/box/alarm?boxNo={boxNo}

      URL2:[apiBaseUrl]v2/box/{boxId}/alarm

      新版:(二选一)

      URL1:[Host Server]/api/v2/box/alarm?boxNo={boxNo}

      URL2:[Host Server]/api/v2/box/{boxId}/alarm

    • 地址参数说明

      字段名 类型 参数描述
      apiBaseUrl string 详情见名词解释
      boxId Long FBox列表获取接口中boxRegs下box下id
      boxNo string FBox的序列号
    • 请求方式

      PUT

    • Headers

      字段名 类型 参数描述
      Authorization string Bearer+ 空格+登录接口中获得的access_token
    • Body
      一次性集合长度不要超过20个

      body为数据监控点列表,JSON格式传输

      字段名 类型 参数描述
      alarmGrpId string 报警点分组Id,若使用alarmGrpId则无需使用dmonGrpName
      alarmGrpName string 报警点分组名称,若使用alarmGrpName属性则无需使用alarmGrpId属性,若分组不存在,系统自动创建,不能超过15个字符
      condition1 int 报警条件一,0:不等于,1:等于,2:大于,3:大于等于,4:小于,5:小于等于
      condtiion2 int 报警条件二,0:不等于,1:等于,2:大于,3:大于等于,4:小于,5:小于等于
      operand1 decimal 操作数1
      operand2 deciaml 操作数2
      condMethod int 条件联合,0:无,1:与,2:或
      alarmMsg string 报警信息(不要包括test,测试等字样),该参数必填
      memo string 备注信息
      devAlias string 设备驱动别名
      station int PLC通讯站号
      dataType int 数据类型,详情见附录二,不支持二进制,十六进制,字符串类型。
      regId int 寄存器Id,与ioWidth联合使用,确定唯一寄存器
      ioWidth int 寄存器位宽,与regId联合使用,确定唯一寄存器
      regName string 寄存器名称,能确定唯一寄存器,与上面两参数任选其一
      addr int PLC主地址
      subAddr int PLC子地址
      addrBlk int PLCDB块地址
      name string 报警条目名称(可不填,若一次增加多个条目,每个条目的名称不能相同)
      valueTransform jobject 数值运算设置
      executeOnEdge boolean 是否启用边缘执行,启用时必须配置数值运算

      数值运算设置详细表

      字段名 类型 描述
      maxValue int 数值上限
      minValue int 数值下限
      scaleMaxValue int 比例上限
      scaleMinValue int 比例下限
      gain int 增益
      offset int 偏移量
      type int 1:比例转换,2:缩放
    • 响应成功

      返回报警条目的Id集合(long)

    • 返回码

      字段名 参数描述
      200 执行成功
      401 accessToken过期
      400 错误信息在HTTP Header里[X-FBox-Code],详细见附录三
      429 访问接口频率过快,详情见429状态码
    • Postman示例如下

    登录接口

    • 使用案例如下图

    登录接口

    Back to top Generated by DocFX