附录：API 接口规范

显示板管理接口

创建显示板

请求参数：

响应参数：

result参数字段：

请求示例：

{

    "action": "create_dashboard",
    "uid": "",
    "name": "demo",
    "type": "pro",
    "description": "",
    "script": {}
}

响应示例：

{
    "resp": "create_dashboard",
    "actionid": "",
    "code": 200,
    "msg": "success",
    "info": "success",
    "result": {
        "id": 784,
        "uid": "DSH18915071400784",
        "name": "demo",
        "type": "pro",
        "description": "",
        "script": [],
        "created": "2021-08-19 15:07:14",
        "last_modified": "2021-08-19 15:07:14"
    }
}

更新显示板

请求参数：

响应参数：

result参数字段：

请求示例：

{
    "action": "update_dashboard",
    "id": 782,
    "uid": "DSH18915024700782",
    "name": "demo",
    "type": "pro",
    "description": "无",
    "script": {}
}

响应示例：

{
    "resp": "update_dashboard",
    "actionid": "",
    "code": 200,
    "msg": "success",
    "info": "success",
    "result": {
        "id": 784,
        "uid": "DSH18915071400784",
        "name": "demo",
        "type": "pro",
        "description": "",
        "script": [],
        "created": "2021-08-19 15:07:14",
        "last_modified": "2021-08-19 15:07:14",
        "is_available": 1,
    }
}

删除显示板

请求参数：

响应参数：

result参数字段：

请求示例：

{
    "action": "delete_dashboard",
    "uid": "DSH18915071400784"
}

响应示例：

{
    "resp": "delete_dashboard",
    "actionid": "",
    "code": 200,
    "msg": "success",
    "info": "success",
    "result": {
        "id": 784,
        "uid": "DSH18915071400784",
        "name": "demo",
        "type": "pro",
        "description": "",
        "script": [],
        "created": "2021-08-19 15:07:14",
        "last_modified": "2021-08-19 15:07:14",
        "is_available": 1,
    }
}

获取显示板详情

请求参数：

响应参数：

result参数字段：

请求示例：

{
    "action": "get_dashboard_item",
    "uid": "DSH18915024700782"
}

响应示例：

{
    "resp": "get_dashboard_item",
    "actionid": "",
    "code": 200,
    "msg": "success",
    "info": "success",
    "result": {
        "id": 784,
        "uid": "DSH18915071400784",
        "name": "demo",
        "type": "pro",
        "description": "",
        "script": [],
         "object_list": [
            "demo",
            "demo0819"
        ],
        "created": "2021-08-19 15:07:14",
        "last_modified": "2021-08-19 15:07:14",
        "is_available": 1,
    }
}

获取显示板列表

请求参数：

响应参数：

result参数字段：

请求示例：

{
    "action": "get_dashboard_list",
    "page_index": 1,
    "page_size": 1,
    "where_and": [["name","like","%demo%"]],
    "where_or": [["name","like","%demo%"]]
}

响应示例：

{
    "resp": "get_dashboard_list",
    "actionid": "",
    "code": 200,
    "msg": "success",
    "info": "success",
    "result": {
        "data": [
            {
                "id": 784,
                "uid": "DSH18915071400784",
                "name": "demo",
                "type": "pro",
                "description": "",
                "script": [],
                "object_list": [
                    "demo",
                    "demo0819"
                ],
                "created": "2021-08-19 15:07:14",
                "last_modified": "2021-08-19 15:07:14",
                "is_available": 1,
            }
        ],
        "page_index": 1,
        "page_size": 1,
        "total_pages": 3,
        "total_records": 3
    }
}

对象绑定显示板

请求参数：

响应参数：

请求示例：

{
    "action": "bind_object_dashboard",
    "object_id":"demo",
    "dashboard_id": ["DSH18915024700782"]
}

响应示例：

{
    "resp": "bind_object_dashboard",
    "actionid": "",
    "code": 200,
    "msg": "success",
    "info": "success",
    "result": {}
}