应用接口

南向设备信息推送接口

• 接口地址：/open/api/northbound/push/device/{topic}/**

• 接口类型：POST

• 请求参数：

{
    // 推送内容
}

• 响应参数：

{
    "code": "200",
    "time": 1686644838284,
    "msg": "操作成功",
    "annex": null,
    "success": true
}

南向事件信息推送接口

• 接口地址：/open/api/northbound/push/event/{topic}/**

• 接口类型：POST

• 请求参数：

{
    // 推送内容
}

• 响应参数：

{
    "code": "200",
    "time": 1686644838284,
    "msg": "操作成功",
    "annex": null,
    "success": true
}

南向扩展功能接口

• 接口地址：/open/api/northbound/func/{protId}/**

• 接口类型：POST

• 请求参数：

path：
    'protId' 南向平台标识

body:
{
    deviceId："是否设备操作",
    func："功能标识",
    req：{
        // 功能参数
    }
}

• 响应参数：

{
    "funcReplyMessage": {
        deviceId："是否设备操作",
        func："功能标识",
        state："状态",
        req：{
            // 功能请求参数
        },
        res：{
            // 功能执行返回数据
        }
    }
}

设备列表查询（批量）

• 接口地址：/open/api/northbound/device/all

• 接口类型：GET

• 请求参数：

• 响应参数：

{
    "code": "200",
    "data"：[
        {
            id:'设备标识',
            name:'设备名称',
            typeId:'设备类型',
            locationId:'未知标识',
            location:'未知详情',
            status:'状态',
            properties:{
                // 附加属性
            }
        },
    ],
    "time": 1686644838284,
    "msg": "操作成功",
    "annex": null,
    "success": true
}

设备列表查询（分页）

• 接口地址：/open/api/northbound/device/page

• 接口类型：GET

• 请求参数：

• 响应参数：

{
    "code": "200",
    "data"：{
        records：[
            {
                id:'设备标识',
                name:'设备名称',
                typeId:'设备类型',
                locationId:'未知标识',
                location:'未知详情',
                status:'状态',
                properties:{
                    // 附加属性
                }
            },
        ],
        total:'',
        size:'',
        current:''
    },
    "time": 1686644838284,
    "msg": "操作成功",
    "annex": null,
    "success": true
}

设备详情查询（分页）

• 接口地址：/open/api/northbound/device/info

• 接口类型：GET

• 请求参数：

• 响应参数：

{
    "code": "200",
    "data"：
        {
            id:'设备标识',
            name:'设备名称',
            typeId:'设备类型',
            locationId:'位置标识',
            location:'位置详情',
            status:'状态',
            properties:{
                // 附加属性
            }
        },
    ,
    "time": 1686644838284,
    "msg": "操作成功",
    "annex": null,
    "success": true
}

告警列表查询（批量）

• 接口地址：/open/api/northbound/alarm/all

• 接口类型：GET

• 请求参数：

• 响应参数：

{
    "code": "200",
    "data"：[
        {
            id:'告警标识',
            deviceName:'设备名称',
            deviceNo:'设备标识',
            deviceType:'设备类型',
            locationId:'位置标识',
            location:'位置详情',
            type："告警类型",
            description："告警说明",
            processingStatus:'状态'
        },
    ],
    "time": 1686644838284,
    "msg": "操作成功",
    "annex": null,
    "success": true
}

告警列表查询（分页）

• 接口地址：/open/api/northbound/alarm/page

• 接口类型：GET

• 请求参数：

• 响应参数：

{
    "code": "200",
    "data"：{
        records：[
            {
                id:'告警标识',
                deviceName:'设备名称',
                deviceNo:'设备标识',
                deviceType:'设备类型',
                locationId:'位置标识',
                location:'位置详情',
                type："告警类型",
                description："告警说明",
                processingStatus:'状态'
            },
        ],
        total:'',
        size:'',
        current:''
    },
    "time": 1686644838284,
    "msg": "操作成功",
    "annex": null,
    "success": true
}

告警详情查询（分页）

• 接口地址：/open/api/northbound/alarm/info

• 接口类型：GET

• 请求参数：

• 响应参数：

{
    "code": "200",
    "data"：
        {
            id:'告警标识',
            deviceName:'设备名称',
            deviceNo:'设备标识',
            deviceType:'设备类型',
            locationId:'位置标识',
            location:'位置详情',
            type："告警类型",
            description："告警说明",
            processingStatus:'状态'
        },
    ,
    "time": 1686644838284,
    "msg": "操作成功",
    "annex": null,
    "success": true
}