1. hapic接口文档

1.1. 文档说明

本文档为离线数据组件API接口说明

1.2. 修订记录

日期 文档版本 修订内容 修改人
2020-12-07 v0.1 添加collect, collectos接口 lizefang

1.3. 接口约定

规则 描述
服务器域名(IP) 以部署为准,如: https://xxx.mixiot.top
接口鉴权 令牌机制,详情请阅接口鉴权
字符编码 统一采用UTF-8编码
响应格式 统一采用JSON格式

1.4. 响应说明

1.4.1. 返回码

code 含义 备注
200 请求成功 Code不为200,则说明请求失败
500 请求错误 -

1.4.2. 格式

1.单条记录

{
    "code":200,
    "msg":"success",
    "info":"",
    "result":{}
}

2.多条记录

{
    "code":200,
    "msg":"success",
    "info":"",
    "result":{
        "page_index":1,
        "page_size":20,
        "total_pages":0,
        "total_records":0,
        "data":[]
    }
}

1.5. 离线项目接口

1.5.1. 获取离线项目

请求地址:

属性
URL /api/v1/collect/getItem
Method get
Content-Type application/json

请求参数:

参数名称 是否必选 数据类型 数据约束 示例数据 描述
id int 编号

响应参数:

参数名称 是否必选 数据类型 描述
code int 返回码
msg string 提示消息
info string 详细信息
result object 返回结果

请求示例

curl -H "Content-Type: application/json" -X GET "https://xxx.mixiot.top/collect/api/v1/collect/getItem?id=1

返回示例:

{
    "code": 200,
    "msg": "成功",
    "info": "",
    "result": {
        "id": 1,
        "name": "test",
        "description": "",
        "block_id": "Collect",
        "class_id": "LZF",
        "is_active": true,
        "option": [
            {
                "OptionID": "Public",
                "OptionName": null,
                "OptionValue": [
                    {
                        "OptionValueID": null,
                        "OptionValueName": null,
                        "Parameter": [
                            {
                                "ParameterID": "DataName",
                                "ParameterName": "数据名称",
                                "ParameterValue": "test"
                            }
                        ]
                    }
                ]
            },
            {
                "OptionID": "CollectApi",
                "OptionName": "采集接口",
                "OptionValue": [
                    {
                        "OptionValueID": "Hapic",
                        "OptionValueName": "Hapic接口",
                        "Parameter": []
                    }
                ]
            },
            {
                "OptionID": "DataTypeExam",
                "OptionName": "离线数据类型检验",
                "OptionValue": [
                    {
                        "OptionValueID": "TrueFalse",
                        "OptionValueName": "开关量",
                        "Parameter": []
                    }
                ]
            }
        ],
        "script": null,
        "created": "2020-12-02T19:12:42+08:00",
        "created_by": 1001,
        "last_modified": "",
        "last_modified_by": 0,
        "is_available": true
    }
}

1.5.2. 获取离线项目列表

请求地址:

属性
URL /api/v1/collect/getList
Method get
Content-Type application/json

请求参数:

参数名称 是否必选 数据类型 数据约束 示例数据 描述
page_index int --- --- 查询页码(默认1)
page_size int --- --- 每页记录数(默认20)
where_and string --- --- AND查询条件
where_or string --- --- OR查询条件
where_in string --- --- IN查询条件

响应参数:

参数名称 是否必选 数据类型 描述
code int 返回码
msg string 提示消息
info string 详细信息
result object 返回结果

请求示例

curl -H "Content-Type: application/json" -X GET "https://xxx.mixiot.top/collect/api/v1/collect/getList?page_index=1&page_size=10

返回示例:

{
    "code": 200,
    "msg": "成功",
    "info": "",
    "result": {
        "page_index": 1,
        "page_size": 10,
        "total_pages": 1,
        "total_records": 1,
        "data": [
            {
                "id": 1,
                "name": "test",
                "description": "",
                "block_id": "Collect",
                "class_id": "LZF",
                "is_active": true,
                "option": [
                    {
                        "OptionID": "Public",
                        "OptionName": null,
                        "OptionValue": [
                            {
                                "OptionValueID": null,
                                "OptionValueName": null,
                                "Parameter": [
                                    {
                                        "ParameterID": "DataName",
                                        "ParameterName": "数据名称",
                                        "ParameterValue": "test"
                                    }
                                ]
                            }
                        ]
                    },
                    {
                        "OptionID": "CollectApi",
                        "OptionName": "采集接口",
                        "OptionValue": [
                            {
                                "OptionValueID": "Hapic",
                                "OptionValueName": "Hapic接口",
                                "Parameter": []
                            }
                        ]
                    },
                    {
                        "OptionID": "DataTypeExam",
                        "OptionName": "离线数据类型检验",
                        "OptionValue": [
                            {
                                "OptionValueID": "TrueFalse",
                                "OptionValueName": "开关量",
                                "Parameter": []
                            }
                        ]
                    }
                ],
                "script": null,
                "created": "2020-12-02T19:12:42+08:00",
                "created_by": 1001,
                "last_modified": "",
                "last_modified_by": 0,
                "is_available": true
            }
        ]
    }
}

1.6. 离线数据接口

1.6.1. 添加离线数据

请求地址:

属性
URL /api/v1/collectos/add
Method post
Content-Type application/json

请求参数:

参数名称 是否必选 数据类型 数据约束 示例数据 描述
name string varchar(64) --- 名称
description string varchar(255) --- 描述
class_id string varchar(32) --- Class标识
project_id int int(11) --- Project编号
object_id int int(11) --- 对象编号
value string text --- 数据值
file string varchar(32) --- 附件路径
collector string varchar(32) --- 采集人
reference string varchar(64) --- 参考号
is_available int tinyint(1) --- 是否有效:1是、0否

响应参数:

参数名称 是否必选 数据类型 描述
code int 返回码
msg string 提示消息
info string 详细信息
result object 返回结果

请求示例

curl -H "Content-Type: application/json" -X POST -d '{
    "name": "一号厂房用电量",
    "description": "一号厂房用电量",
    "class_id": "厂房用电量统计",
    "project_id": 1,
    "object_id": 1001,
    "value": 1,
    "file": "/var/log/defalut.png",
    "collector": "小黄",
    "reference": "参考号1",
    "is_availabel": 1
}' "https://xxx.mixiot.top/collect/api/v1/collectos/add"

返回示例:

{
    "code": 200,
    "msg": "成功"
}

1.6.2. 更新离线数据

请求地址:

属性
URL /api/v1/collectos/edit
Method post
Content-Type application/json

请求参数:

参数名称 是否必选 数据类型 数据约束 示例数据 描述
id int int(11) --- 编号
name string varchar(64) --- 名称
description string varchar(255) --- 描述
class_id string varchar(32) --- Class标识
project_id int int(11) --- Project编号
object_id int int(11) --- 对象编号
value string text --- 数据值
file string varchar(32) --- 附件路径
collector string varchar(32) --- 采集人
reference string varchar(64) --- 参考号
is_available int tinyint(1) --- 是否有效:1是、0否

响应参数:

参数名称 是否必选 数据类型 描述
code int 返回码
msg string 提示消息
info string 详细信息
result object 返回结果

请求示例

curl -H "Content-Type: application/json" -X POST -d '{
    "id": 1,
    "name": "一号厂房用电量",
    "description": "一号厂房用电量",
    "class_id": "厂房用电量统计",
    "project_id": 1,
    "object_id": 1001,
    "value": 1,
    "file": "/var/log/defalut.png",
    "collector": "小黄",
    "reference": "参考号1",
    "is_availabel": 1
}' "https://xxx.mixiot.top/collect/api/v1/collectos/edit"

返回示例:

{
    "code": 200,
    "msg": "成功"
}

1.6.3. 删除离线数据

请求地址:

属性
URL /api/v1/collectos/delete
Method post
Content-Type application/json

请求参数:

参数名称 是否必选 数据类型 数据约束 示例数据 描述
id int int(11) - 编号

响应参数:

参数名称 是否必选 数据类型 描述
code int 返回码
msg string 提示消息
info string 详细信息
result object 返回结果

请求示例

curl -H "Content-Type: application/json" -X POST -d '{
    "id": 1
}' "https://xxx.mixiot.top/collect/api/v1/collectos/delete"

返回示例:

{
    "code": 200,
    "msg": "成功"
}

1.6.4. 获取离线数据

请求地址:

属性
URL /api/v1/collectos/getItem
Method get
Content-Type application/json

请求参数:

参数名称 是否必选 数据类型 数据约束 示例数据 描述
id int int(11) --- 编号

响应参数:

参数名称 是否必选 数据类型 描述
code int 返回码
msg string 提示消息
info string 详细信息
result object 返回结果

请求示例

curl -H "Content-Type: application/json" -X GET "https://xxx.mixiot.top/collect/api/v1/collectos/getItem?id=1"

返回示例:

{
    "code": 200,
    "msg": "成功",
    "info": "",
    "result": {
        "id": 1,
        "name": "一号厂房用电量",
        "description": "一号厂房用电量",
        "class_id": "厂房用电量统计",
        "project_id": 1,
        "object_id": 1001,
        "value": "1",
        "file": "/var/log/defalut.png",
        "collector": "小黄",
        "collect_at": "2020-12-02 19:14:17",
        "reference": "参考号1",
        "created": "2020-12-02 19:14:17",
        "is_available": 1
    }
}

1.6.5. 获取最新离线数据

请求地址:

属性
URL /api/v1/collectos/getLastItem
Method get
Content-Type application/json

请求参数:

参数名称 是否必选 数据类型 数据约束 示例数据 描述
project_id int int(11) --- 项目编号
object_id int int(11) --- 对象编号

响应参数:

参数名称 是否必选 数据类型 描述
code int 返回码
msg string 提示消息
info string 详细信息
result object 返回结果

请求示例

curl -H "Content-Type: application/json" -X GET "https://xxx.mixiot.top/collect/api/v1/collectos/getLastItem?project_id=1&object_id=1001"

返回示例:

{
    "code": 200,
    "msg": "成功",
    "info": "",
    "result": {
        "id": 1,
        "name": "一号厂房用电量",
        "description": "一号厂房用电量",
        "class_id": "厂房用电量统计",
        "project_id": 1,
        "object_id": 1001,
        "value": "1",
        "file": "/var/log/defalut.png",
        "collector": "小黄",
        "collect_at": "2020-12-02 19:14:17",
        "reference": "参考号1",
        "created": "2020-12-02 19:14:17",
        "is_available": 1
    }
}

1.6.6. 获取离线数据列表

请求地址:

属性
URL /api/v1/collectos/getList
Method get
Content-Type application/json

请求参数:

参数名称 是否必选 数据类型 数据约束 示例数据 描述
page_index int --- --- 查询页码(默认1)
page_size int --- --- 每页记录数(默认20)
where_and string --- --- AND查询条件
where_or string --- --- OR查询条件
where_in string --- --- IN查询条件

响应参数:

参数名称 是否必选 数据类型 描述
code int 返回码
msg string 提示消息
info string 详细信息
result object 返回结果
+ page_index --- int 页索引
+ page_size --- int 页条数
+ total_pages --- int 总页数
+ total_records --- int 总条数
+ data --- array 返回数据列表

请求示例

curl -H "Content-Type: application/json" -X GET "https://xxx.mixiot.top/collect/api/v1/collectos/getList?page_index=1&page_size=10&where_and=[["is_available","=","1"]]&where_or=[["id","=","1"],["id","=","2"]]&where_in=["id","1,2"]"

返回示例:

{
    "code": 200,
    "msg": "成功",
    "info": "",
    "result": {
        "page_index": 1,
        "page_size": 10,
        "total_pages": 1,
        "total_records": 1,
        "data": [
            {
                "id": 1,
                "name": "一号厂房用电量",
                "description": "一号厂房用电量",
                "class_id": "厂房用电量统计",
                "project_id": 1,
                "object_id": 1001,
                "value": "1",
                "file": "/var/log/defalut.png",
                "collector": "小黄",
                "collect_at": "2020-12-02 19:14:17",
                "reference": "参考号1",
                "created": "2020-12-02 19:14:17",
                "is_available": 1
            }
        ]
    }
}
© Mixlinker all right reserved,powered by Gitbook文件修订时间: 2021-03-05 16:09:24

results matching ""

    No results matching ""