2.4.1.7. 接口定义 - 2.4.1.7.5. Aprus（适配器） - 《Mixlinker MixIOT 中文文档》

2.4.1.7.5. Aprus（适配器）

2.4.1.7.5. Aprus（适配器）

2.4.1.7.5.1. 查询Aprus详细列表

调用接口：

属性	值
url	/api/aprus/get_list
http方法	post
Content-Type	application/json或application/x-www-form-urlencoded

请求参数：

字段	字段名称	字段类型	说明	是否必传
page_index	查询页码	Integer	大于 0，如果为空，则默认从第一页显示	否
page_size	每页记录数	Integer	大于 0，如果为空，则默认为 20	否
condition	查询条件	Json	LIKE模糊搜索条件	否
start_time	开始时间	Datetime	按创建时间搜索的开始时间和结束时间	否
end_time	结束时间	Datetime		否

condition参数：

格式

[["${key}", "${operator}", "${value}"]] 即 [["查询值", "运算符", "查询内容"]]

举例

[["aprus_id", "like", "fidiser"], ["aprus_name", "=", "专用适配器"]]

返回参数：

字段	字段名称	字段类型	说明	是否必传
code	返回码	Integer	200：成功 500：失败	是
msg	提示信息	String		是
result	结果	Json		是

返回示例：

{
    "code": 200,
    "msg": "查询成功",
    "mix_code":130001,
    "mix_msg":"",
    "mix_ext":"",
    "result": {
        "page_index": 1,
        "page_size": 20,
        "total_pages": 1,
        "total_records": 1,
        "data": [
            {
                "aprus_id": "A201812060003",
                "aprus_name": "空压机-0766",
                "access": "pub",
                "topic": "r,a,v,p,i,n,d",
                "description": "无",
                "maker": "智物联",
                "config_id": 1002,
                "codebase_id": 1001,
                "nominal": null,
                "activated": "2018-08-31 16:37:39",
                "type": "2",
                "template": null,
                "script": null,
                "reference": null,
                "created": "2018-08-31 16:37:39",
                "is_available": 1
            }
        ]
    }
}

2.4.1.7.5.2. 查询Aprus指定记录

调用接口：

属性	值
url	/api/aprus/get
http方法	post
Content-Type	application/json或application/x-www-form-urlencoded

请求参数：

字段	字段名称	字段类型	说明	是否必传
aprus_id	适配器标识	String	适配器标识	是

返回参数：

字段	字段名称	字段类型	说明	是否必传
code	返回码	Integer	200：成功 500：失败	是
msg	提示信息	String		是
result	返回结果	Json		是

返回示例：

{
    "code": 200,
    "msg": "查询成功",
    "mix_code":130001,
    "mix_msg":"",
    "mix_ext":"",
    "result": {
        "aprus_id": "A201812060003",
        "aprus_name": "空压机-0766",
        "access": "pub",
        "topic": "r,a,v,p,i,n,d",
        "description": "无",
        "maker": "智物联",
        "config_id": 1002,
        "codebase_id": 1001,
        "nominal": null,
        "activated": "2018-08-31 16:37:39",
        "type": "2",
        "template": null,
        "script": null,
        "reference": null,
        "created": "2018-08-31 16:37:39",
        "is_available": 1
    }
}

2.4.1.7.5.3. 添加Aprus

调用接口：

属性	值
url	/api/aprus/add
http方法	post
Content-Type	application/json或application/x-www-form-urlencoded

请求参数：

字段	字段名称	字段类型	说明	是否必传
aprus_id	适配器标识	String		是
aprus_name	适配器名称	String		是
description	描述	Text		否
username	鉴权用户名	String		否
pin	鉴权验证码	String		否
access	报文权限	String	单选：all,pub,sub	否
topic	报文主题	String	多选： all:all pub:r,a,v,p,i,n sub:g/#	否
maker	生产厂家	String		否
config_id	适配器配置标识	String	对应config表	否
codebase_id	代码库	String	对应codebase	否
template	模板/样式	text		否
script	脚本	text		否
reference	参考号	String		否

返回参数：

字段	字段名称	字段类型	说明	是否必传
code	返回码	Integer	200：成功 500：失败	是
msg	提示信息	String		是
result	返回结果	Json		是

返回示例：

{
    "code": 200,
    "msg": "添加成功",
    "mix_code":130001,
    "mix_msg":"",
    "mix_ext":"",
    "result": []
}

2.4.1.7.5.4. 编辑Aprus

调用接口：

属性	值
url	/api/customer/edit
http方法	post
Content-Type	application/json或application/x-www-form-urlencoded

请求参数：

字段	字段名称	字段类型	说明	是否必传
aprus_id	适配器标识	String		是
aprus_name	适配器名称	String		是
description	描述	Text		否
username	鉴权用户名	String		否
pin	鉴权验证码	String		否
access	报文权限	String	单选：all,pub,sub	否
topic	报文主题	String	多选： all:all pub:r,a,v,p,i,n sub:g/#	否
description	描述	text		否
maker	生产厂家	String		否
config_id	适配器配置标识	String	对应config表	否
codebase_id	代码库	String	对应codebase	否
nominal	公称名义	String	不可编辑	否
activated	激活时间	datetime	不可编辑	否
template	模板/样式	text		否
script	脚本	text		否
reference	参考号	String		否

返回参数：

字段	字段名称	字段类型	说明	是否必传
code	返回码	Integer	200：成功 500：失败	是
msg	提示信息	String		是
result	返回结果	Json		是

返回示例：

{
    "code": 200,
    "msg": "编辑成功",
    "mix_code":130001,
    "mix_msg":"",
    "mix_ext":"",
    "result": []
}

2.4.1.7.5.5. 删除Aprus

调用接口：

属性	值
url	/api/aprus/delete
http方法	post
Content-Type	application/json或application/x-www-form-urlencoded

请求参数：

字段	字段名称	字段类型	说明	是否必传
aprus_id	适配器标识	String		是

返回参数：

字段	字段名称	字段类型	说明	是否必传
code	返回码	Integer	200：成功 500：失败	是
msg	提示信息	String		否

返回参数：

字段	字段名称	字段类型	说明	是否必传
code	返回码	Integer	200：成功 500：失败	是
msg	提示信息	String		是
result	返回结果	Json		是

返回示例：

{
    "code": 200,
    "msg": "删除成功",
    "mix_code":130001,
    "mix_msg":"",
    "mix_ext":"",
    "result": []
}