2.4.1.7. 接口定义 - 2.4.1.7.12. Dashboard（显示板） - 《Mixlinker MixIOT 中文文档》

2.4.1.7.12. Dashboard（显示板）

2.4.1.7.12. Dashboard（显示板）

2.4.1.7.12.1. 查询Dashboard详细列表

调用接口：

属性	值
url	/api/dashboard/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}"]] 即 [["查询值", "运算符", "查询内容"]]

举例

[["dashboard_id", "=", "1001"]]

返回参数：

字段	字段名称	字段类型	说明	是否必传
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": [
            {
                "dashboard_id": 1003,
                "dashboard_name": "设备大屏模板",
                "description": "",
                "template": "[]",
                "script": "[]",
                "mixshow": "[]",
                "exp": "[]",
                "reference": "",
                "created": "2018-10-17 13:59:21",
                "is_available": 1,
                "boss_sync": 0
            }
        ]
    }
}

2.4.1.7.12.2. 查询Dashboard指定记录

调用接口：

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

请求参数：

字段	字段名称	字段类型	说明	是否必传
dashboard_id	显示板标识	String		是

返回参数：

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

返回示例：

{
    "code": 200,
    "msg": "查询成功",
    "mix_code":130001,
    "mix_msg":"",
    "mix_ext":"",
    "result": {
        "dashboard_id": 1003,
        "dashboard_name": "设备大屏模板",
        "description": "",
        "template": "[]",
        "script": "[]",
        "mixshow": "[]",
        "exp": "[]",
        "reference": "",
        "created": "2018-10-17 13:59:21",
        "is_available": 1,
        "boss_sync": 0
    }
}

2.4.1.7.12.3. 添加Dashboard

调用接口：

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

请求参数：

字段	字段名称	字段类型	是否必传
dashboard_name	显示板名称	String	是
description	描述	Text	否
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.12.4. 编辑Dashboard

调用接口：

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

请求参数：

字段	字段名称	字段类型	说明	是否必传
dashboard_id	显示板标识	String		是
dashboard_name	显示板名称	String		是
description	描述	Text		否
template	模板/样式	text		否
script	脚本	text		否
reference	参考号	String		否
is_available	是否有效	Boolean	1：是，0：否	否

返回参数：

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

返回示例：

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

2.4.1.7.12.5. 删除Dashboard

调用接口：

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

请求参数：

字段	字段名称	字段类型	说明	是否必传
dashboard_id	显示板标识	String		是

返回参数：

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

返回示例：

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