对象管理接口

映射表指令

创建映射表

请求参数：

参数名称 是否必选 数据类型 描述
action 是 string 指令
actionid 否 string 指令编号
organization_id 否 string 组织ID
uid 否 string 唯一编号
name 是 string 映射表名称
description 否 string 映射表描述
script 是 string 映射表脚本
addition 否 string 附加信息
reference 否 string 参考号
created_by 是 int 创建人
last_modified_by 是 int 更新人
is_available 是 int 是否生效

响应参数：

参数名称 数据类型 描述
resp string 返回指令
actionid string 返回指令编号
code int 返回码
msg string 提示消息
info string 详细信息
result object 返回结果

result:

参数名称 数据类型 描述
uid string 返回映射表唯一编号

请求示例：

curl -H "Content-Type: application/json" -X POST -d '{
    "action": "create_mapping",
    "actionid": "123454",
    "name": "mapping1",
    "description": "mapping number 1",
    "script": "[[\"v1\", \"\", \"STA变量-相对适配器\", \"STA\", \"$AprusID-1.L1_3_7_2\", \"\", \"\"], [\"v2\", \"\", \"STA变量-相对适配器\", \"STA\", \"$AprusID-1.L1_3_7_2\", \"v1+10\", \"\"], [\"v3\", \"\", \"STA变量-固定适配器\", \"STA\", \"AX20210229000249.L1_3_7_2\", \"v2+10\", \"\"], [\"v4\", \"\", \"离线推送\", \"STA\", \"$CollectID-1.Tem\", \"Tem+20\", \"\"], [\"v5\", \"\", \"离线推送\", \"STA\", \"COL12236500002.Tem\", \"Tem+5\", \"\"], [\"v6\", \"\", \"函数计算\", \"STA\", \"$AprusID-1.L1_3_7_2\", \"min(v1, v2)\", \"\"], [\"v7\", \"\", \"比较运算\", \"STA\", \"$AprusID-1.L1_3_7_2\", \"v1>v2?v1:v2\", \"\"], [\"1001\", \"start event\", \"开始事件\", \"EVNT\", \"$AprusID-1.L1_3_7_2\", \"\", \"v1==0\"], [\"1002\", \"stop event\", \"停止事件\", \"EVNT\", \"$AprusID-1.L1_3_7_2\", \"\", \"v1==1\"]]",
    "addition": "{\"id\":1}",
    "reference": "参考号123",
    "created_by": 1,
    "last_modified_by": 1,
    "is_available": 1
}' http://192.168.88.202:8011/mapping/api

响应示例：

{
    "resp": "create_mapping",
    "actionid": "123454",
    "code": 200,
    "msg": "成功",
    "result": {
        "uid": "MAP1324472700003",
        "name": "mapping1"
    }
}

更新映射表

请求参数：

参数名称 是否必选 数据类型 描述
action 是 string 指令
actionid 否 string 指令编号
organization_id 否 string 组织ID
uid 是 string 映射表唯一编号
name 是 string 映射表名称
description 否 string 映射表描述
script 是 string 映射表脚本
addition 否 string 附加信息
reference 否 string 参考号
created_by 是 int 创建人
last_modified_by 是 int 更新人
is_available 是 int 是否生效

响应参数：

参数名称 数据类型 描述
resp string 返回指令
actionid string 返回指令编号
code int 返回码
msg string 提示消息
info string 详细信息
result object 返回结果

请求示例：

curl -H "Content-Type: application/json" -X POST -d '{
    "action": "update_mapping",
    "actionid": "123454",
    "uid": "MAP1324472700003",
    "name": "mapping1",
    "description": "mapping number 1",
    "script": "[[\"v1\", \"\", \"STA变量-相对适配器\", \"STA\", \"$AprusID-1.L1_3_7_2\", \"\", \"\"], [\"v2\", \"\", \"STA变量-相对适配器\", \"STA\", \"$AprusID-1.L1_3_7_2\", \"v1+10\", \"\"], [\"v3\", \"\", \"STA变量-固定适配器\", \"STA\", \"AX20210229000249.L1_3_7_2\", \"v2+10\", \"\"], [\"v4\", \"\", \"离线推送\", \"STA\", \"$CollectID-1.Tem\", \"Tem+20\", \"\"], [\"v5\", \"\", \"离线推送\", \"STA\", \"COL12236500002.Tem\", \"Tem+5\", \"\"], [\"v6\", \"\", \"函数计算\", \"STA\", \"$AprusID-1.L1_3_7_2\", \"min(v1, v2)\", \"\"], [\"v7\", \"\", \"比较运算\", \"STA\", \"$AprusID-1.L1_3_7_2\", \"v1>v2?v1:v2\", \"\"], [\"1001\", \"start event\", \"开始事件\", \"EVNT\", \"$AprusID-1.L1_3_7_2\", \"\", \"v1==0\"], [\"1002\", \"stop event\", \"停止事件\", \"EVNT\", \"$AprusID-1.L1_3_7_2\", \"\", \"v1==1\"]]",
    "addition": "{\"id\":1}",
    "reference": "参考号123",
    "created_by": 1,
    "last_modified_by": 1,
    "is_available": 1
}' http://192.168.88.202:8011/mapping/api

响应示例：

{
    "resp": "update_mapping",
    "actionid": "123454",
    "code": 200,
    "msg": "成功"
}

删除映射表

请求参数：

参数名称 是否必选 数据类型 描述
action 是 string 指令
actionid 否 string 指令编号
uid 是 string 映射表唯一编号

响应参数：

参数名称 数据类型 描述
resp string 返回指令
actionid string 返回指令编号
code int 返回码
msg string 提示消息
info string 详细信息
result object 返回结果

请求示例：

curl -H "Content-Type: application/json" -X POST -d '{
    "action": "delete_mapping",
    "actionid": "123456",
    "uid": "MAP1324472700003"
}' http://192.168.88.202:8011/mapping/api

响应示例：

{
    "resp": "delete_mapping",
    "actionid": "123456",
    "code": 200,
    "msg": "成功"
}

映射表详情

请求参数：

参数名称 是否必选 数据类型 描述
action 是 string 指令
actionid 否 string 指令编号
uid 是 string 映射表唯一编号

响应参数：

参数名称 数据类型 描述
resp string 返回指令
actionid string 返回指令编号
code int 返回码
msg string 提示消息
info string 详细信息
result object 返回结果

object:

参数名称 数据类型 描述
action string 指令
actionid string 指令编号
organization_id string 组织ID
uid string 映射表唯一编号
name string 映射表名称
description string 映射表描述
script []array 映射表脚本
addition []object 附加信息
reference string 参考号
created string 创建时间
created_by int 创建人
last_modified string 更新人
last_modified_by int 更新人
is_available int 是否生效

请求示例：

curl -H "Content-Type: application/json" -X POST -d '{
    "action": "get_mapping_item",
    "actionid": "12345",
    "uid": "MAP1212994600001"
}' http://192.168.88.202:8011/mapping/api

响应示例：

{
    "resp": "get_mapping_item",
    "actionid": "12345",
    "code": 200,
    "msg": "成功",
    "result": {
        "id": 1020,
        "uid": "MAP1212994600001",
        "name": "mapping",
        "description": "mapping number 1",
        "script": [
            [
                "v1",
                "",
                "STA变量-相对适配器",
                "STA",
                "$AprusID-1.L1_3_7_2",
                "",
                ""
            ],   
            [
                "v6",
                "",
                "函数计算",
                "STA",
                "$AprusID-1.L1_3_7_2",
                "min(v1, v2)",
                ""
            ],
            [
                "v7",
                "",
                "比较运算",
                "STA",
                "$AprusID-1.L1_3_7_2",
                "v1>v2?v1:v2",
                ""
            ],
            [
                "v11",
                "",
                "STA变量-相对适配器",
                "STA",
                "$AprusID-1.L1_3_7_2",
                "v1+10",
                ""
            ],      
        ],
        "addition": [
            {
                "data": [
                    [
                        "a",
                        ""
                    ],
                    [
                        "b",
                        ""
                    ]
                ],
                "title": "扩展信息1"
            }
        ],
        "reference": "参考号123",
        "created": "2021-02-21 14:13:30",
        "created_by": 1,
        "last_modified": "2021-03-25 14:51:53",
        "last_modified_by": 1,
        "is_available": 1
    }
}

映射表列表

请求参数：

参数名称 是否必选 数据类型 描述
action 是 string 指令
actionid 否 string 指令编号

响应参数：

参数名称 数据类型 描述
resp string 返回指令
actionid string 返回指令编号
code int 返回码
msg string 提示消息
info string 详细信息
result []object 返回结果

object:

参数名称 数据类型 描述
action string 指令
actionid string 指令编号
organization_id string 组织ID
uid string 映射表唯一编号
name string 映射表名称
description string 映射表描述
script []array 映射表脚本
addition []object 附加信息
reference string 参考号
created string 创建时间
created_by int 创建人
last_modified string 更新人
last_modified_by int 更新人
is_available int 是否生效

请求示例：

curl -H "Content-Type: application/json" -X POST -d '{
    "action": "get_mapping_list",
    "actionid": "12345"
}' http://192.168.88.202:8011/mapping/api

响应示例：

{
    "resp": "get_mapping_list",
    "actionid": "12345",
    "code": 200,
    "msg": "成功",
    "result": [
        {
            "id": 1020,
            "uid": "MAP1212994600001",
            "name": "mapping",
            "description": "mapping number 1",
            "script": [
                [
                    "v1",
                    "",
                    "STA变量-相对适配器",
                    "STA",
                    "$AprusID-1.L1_3_7_2",
                    "",
                    ""
                ],
                [
                    "v2",
                    "",
                    "STA变量-相对适配器",
                    "STA",
                    "$AprusID-1.L1_3_7_2",
                    "v1+10",
                    ""
                ],
                [
                    "v3",
                    "",
                    "STA变量-相对适配器",
                    "STA",
                    "$AprusID-1.L1_3_7_2",
                    "",
                    ""
                ],
                [
                    "v4",
                    "",
                    "STA变量-相对适配器",
                    "STA",
                    "$AprusID-1.L1_3_7_2",
                    "v1+10",
                    ""
                ]
            ],
            "addition": [
                {
                    "data": [
                        [
                            "a",
                            ""
                        ],
                        [
                            "b",
                            ""
                        ]
                    ],
                    "title": "扩展信息1"
                }
            ],
            "reference": "参考号123",
            "created": "2021-02-21 14:13:30",
            "created_by": 1,
            "last_modified": "2021-03-25 14:51:53",
            "last_modified_by": 1,
            "is_available": 1
        }
    ]
}

对象指令

创建对象

请求参数：

参数名称 是否必选 数据类型 描述
action 是 string 指令
actionid 否 string 指令编号
organization_id 否 string 组织ID
uid 否 string 唯一编号
name 是 string 对象名称
description 否 string 对象描述
image 否 string 图片路径
province 否 string 省份
city 否 string 城市/地区
mapping_id 是 string 映射表编号
control_id 否 string 控制码编号
terminal_list 是 []string 终端列表
object_list 否 []string 对象列表
collect_list 否 []string 离线列表
tag 否 []string 标签列表
model 否 string 型号
serial_no 否 string 序列号
gis 否 string 位置信息
secret 否 string 关注密码
control 否 string 控制代码
addition 否 string 附加信息
reference 否 string 参考号
created_by 是 int 创建人
last_modified_by 是 int 更新人
is_available 是 int 是否生效

响应参数：

参数名称 数据类型 描述
resp string 返回指令
actionid string 返回指令编号
code int 返回码
msg string 提示消息
info string 详细信息
result object 返回结果

result:

参数名称 数据类型 描述
uid string 返回对象唯一编号

请求示例：

curl -H "Content-Type: application/json" -X POST -d '{
    "action": "create_object",
    "actionid": "",
    "name": "object1",
    "description": "temperature object",
    "image": "/var/image/default.png",
    "province": "广东省",
    "city": "深圳市",
    "mapping_id": "MAP1212994600001",
    "control_id": "CTL1212994600001",
    "terminal_list": ["test","test1"],
    "object_list": [],
    "collect_list": ["test","test1"],
    "tag": ["test","test1"],
    "model": "model1",
    "serial_no": "1234566778999999",
    "gis": "深圳南山区",
    "secret": "1234567887654321",
    "control": "1234567887654321",
    "addition": "{\"id\":1}",
    "reference": "123456",
    "created_by": 1,
    "last_modified_by": 1,
    "is_available": 1
}' http://192.168.88.202:8011/mapping/api

响应示例：

{
    "resp": "create_object",
    "actionid": "",
    "code": 200,
    "msg": "成功",
    "result": {
        "uid": "OBJ1321207800001",
        "name": "object1"
    }
}

更新对象

请求参数：

参数名称 是否必选 数据类型 描述
action 是 string 指令
actionid 否 string 指令编号
organization_id 否 string 组织ID
uid 是 string 对象唯一编号
name 是 string 对象名称
description 否 string 对象描述
image 否 string 图片路径
province 否 string 省份
city 否 string 城市/地区
mapping_id 是 string 映射表编号
control_id 否 string 控制码编号
terminal_list 是 []string 终端列表
object_list 否 []string 对象列表
collect_list 否 []string 离线列表
tag 否 []string 标签列表
model 否 string 型号
serial_no 否 string 序列号
gis 否 string 位置信息
secret 否 string 关注密码
control 否 string 控制代码
addition 否 string 附加信息
reference 否 string 参考号
created_by 是 int 创建人
last_modified_by 是 int 更新人
is_available 是 int 是否生效

响应参数：

参数名称 数据类型 描述
resp string 返回指令
actionid string 返回指令编号
code int 返回码
msg string 提示消息
info string 详细信息
result object 返回结果

请求示例：

curl -H "Content-Type: application/json" -X POST -d '{
    "action": "update_object",
    "actionid": "",
    "id": 1001,
    "uid": "OBJ1321207800001",
   "name": "object1",
    "description": "temperature object",
    "image": "/var/image/default.png",
    "province": "广东省",
    "city": "深圳市",
    "mapping_id": "MAP1212994600001",
    "control_id": "CTL1212994600001",
    "terminal_list": ["test","test1"],
    "object_list": [],
    "collect_list": ["test","test1"],
    "tag": ["test","test1"],
    "model": "model1",
    "serial_no": "1234566778999999",
    "gis": "深圳南山区",
    "secret": "1234567887654321",
    "control": "1234567887654321",
    "addition": "{\"id\":1}",
    "reference": "123456",
    "created_by": 1,
    "last_modified_by": 1,
    "is_available": 1
}' http://192.168.88.202:8011/mapping/api

响应示例：

{
    "resp": "update_object",
    "actionid": "",
    "code": 200,
    "msg": "成功"
}

删除对象

请求参数：

参数名称 是否必选 数据类型 描述
action 是 string 指令
actionid 否 string 指令编号
uid 是 string 对象唯一编号

响应参数：

参数名称 数据类型 描述
resp string 返回指令
actionid string 返回指令编号
code int 返回码
msg string 提示消息
info string 详细信息
result object 返回结果

请求示例：

curl -H "Content-Type: application/json" -X POST -d '{
    "action": "delete_object",
    "actionid": "123",
    "uid": "OBJ1321207800001"
}' http://192.168.88.202:8011/mapping/api

响应示例：

{
    "resp": "delete_object",
    "actionid": "123",
    "code": 200,
    "msg": "成功"
}

对象详情

请求参数：

参数名称 是否必选 数据类型 描述
action 是 string 指令
actionid 否 string 指令编号
uid 是 string 对象唯一编号

响应参数：

参数名称 数据类型 描述
resp string 返回指令
actionid string 返回指令编号
code int 返回码
msg string 提示消息
info string 详细信息
result object 返回结果

object：

参数名称 数据类型 描述
id int 表自增编号
organization_id string 组织ID
uid string 对象唯一编号
name string 对象名称
description string 对象描述
image string 图片路径
province string 省份
city string 城市/地区
mapping_id string 映射表编号
control_id string 控制码编号
terminal_list []string 终端列表
object_list []string 对象列表
collect_list []string 离线列表
tag []string 标签列表
model string 型号
serial_no string 序列号
gis string 位置信息
secret string 关注密码
control string 控制代码
addition object 附加信息
reference string 参考号
created string 创建时间
created_by int 创建人
last_modified string 更新时间
last_modified_by int 更新人
is_available int 是否生效
is_boot int 是否启动
object_fv_map object 对象的fv映射关系

请求示例：

curl -H "Content-Type: application/json" -X POST -d '{
    "action": "get_object_item",
    "actionid": "123",
    "uid": "OBJ1310573400002"
}' http://192.168.88.202:8011/mapping/api

响应示例：

{
    "resp": "get_object_item",
    "actionid": "123",
    "code": 200,
    "msg": "成功",
    "result": {
        "id": 1047,
        "uid": "OBJ1310573400002",
        "name": "object1",
        "description": "temperature object",
        "image": "/var/image/default.png",
        "province": "广东省",
        "city": "深圳市",
        "mapping_id": "MAP1212994600001",
        "control_id": "CTL1212994600001",
        "terminal_list": [
            "test",
            "test1"
        ],
        "object_list": [],
        "collect_list": [
            "test",
            "test1"
        ],
        "tag": [
            "test",
            "test1"
        ],
        "model": "model1",
        "serial_no": "1234566778999999",
        "gis": "深圳南山区",
        "secret": "1234567887654321",
        "control": "1234567887654321",
        "addition": {
            "id": 1
        },
        "reference": "123456",
        "created": "2021-03-11 17:10:06",
        "created_by": 1,
        "last_modified": "2021-03-11 17:10:06",
        "last_modified_by": 1,
        "is_available": 1,
        "is_online": 0,
        "is_boot": 0,
        "object_fv_map": {
            "OBJ1310573400002": [
                {
                    "object_id": "OBJ1310573400002",
                    "fv": "v1",
                    "label_en": "",
                    "label_local": "STA变量-相对适配器",
                    "category": "STA",
                    "datasource": "test.L1_3_7_2",
                    "logic_expr1": "",
                    "logic_expr2": "return true"
                }
            ]
        }
    }
}

对象列表

请求参数：

参数名称 是否必选 数据类型 描述
action 是 string 指令
actionid 否 string 指令编号
uids 否 []string 对象编号列表，若存在，则返回指定对象编号列表的对象

响应参数：

参数名称 数据类型 描述
resp string 返回指令
actionid string 返回指令编号
code int 返回码
msg string 提示消息
info string 详细信息
result []object 返回结果

object：

参数名称 数据类型 描述
id int 表自增编号
organization_id string 组织ID
uid string 对象唯一编号
name string 对象名称
description string 对象描述
image string 图片路径
province string 省份
city string 城市/地区
mapping_id string 映射表编号
control_id string 控制码编号
terminal_list []string 终端列表
object_list []string 对象列表
collect_list []string 离线列表
tag []string 标签列表
model string 型号
serial_no string 序列号
gis string 位置信息
secret string 关注密码
control string 控制代码
addition object 附加信息
reference string 参考号
created string 创建时间
created_by int 创建人
last_modified string 更新时间
last_modified_by int 更新人
is_available int 是否生效
is_boot int 是否启动
object_fv_map object 对象的fv映射关系

请求示例：

curl -H "Content-Type: application/json" -X POST -d '{
    "action": "get_object_list",
    "actionid": "1234",
    "uids": ["OBJ1343732600001", "OBJ1312304800002"]
}' http://192.168.88.202:8011/mapping/api

响应示例：

{
    "resp": "get_object_list",
    "actionid": "1234",
    "code": 200,
    "msg": "成功",
    "result": [
        {
            "id": 1028,
            "uid": "OBJ1343732600001",
            "name": "object1",
            "description": "temperature object",
            "image": "/var/image/default.png",
            "province": "广东省",
            "city": "深圳市",
            "mapping_id": "MAP1352825300001",
            "control_id": "CTL1212994600001",
            "terminal_list": [
                "test",
                "test1"
            ],
            "object_list": [
                "OBJ1343732600001"
            ],
            "collect_list": [
                "test",
                "test1"
            ],
            "tag": [
                "test",
                "test1"
            ],
            "model": "model1",
            "serial_no": "1234566778999999",
            "gis": "深圳南山区",
            "secret": "1234567887654321",
            "control": "1234567887654321",
            "addition": {
                "id": 1
            },
            "reference": "123456",
            "created": "2021-03-04 11:50:37",
            "created_by": 1,
            "last_modified": "2021-03-04 11:50:37",
            "last_modified_by": 1,
            "is_available": 1,
            "is_online": 0,
            "is_boot": 0,
            "object_fv_map": {
                "OBJ1343732600001": [
                    {
                        "object_id": "OBJ1343732600001",
                        "fv": "v1",
                        "label_en": "",
                        "label_local": "STA变量-相对适配器",
                        "category": "STA",
                        "datasource": "test.L1_3_7_2",
                        "logic_expr1": "",
                        "logic_expr2": "return true"
                    }
                ]
            }
        }
    ]
}

控制码指令

创建控制码

请求参数：

参数名称 是否必选 数据类型 描述
action 是 string 指令
actionid 否 string 指令编号
organization_id 否 string 组织ID
uid 否 string 唯一编号
name 是 string 控制码编号
description 否 string 控制码描述
script 是 string 控制码脚本
template 否 string 控制码模板
reference 否 string 参考号
created_by 是 int 创建人
last_modified_by 是 int 更新人
is_available 是 int 是否生效

响应参数：

参数名称 数据类型 描述
resp string 返回指令
actionid string 返回指令编号
code int 返回码
msg string 提示消息
info string 详细信息
result object 返回结果

result:

参数名称 数据类型 描述
uid string 返回控制码唯一编号

请求示例：

curl -H "Content-Type: application/json" -X POST -d '{
    "action": "create_control",
    "actionid": "123455",
    "name": "control1",
    "description": "control number 1",
    "script": "[[\"S001\",\"\",\"模拟变量1\",\"OBJ\",\"$AprusID-1.L1_3_8\",\"\"],[\"S002\",\"\",\"模拟变量2\",\"OBJ\",\"$AprusID-1.L1_3_9\",\"\"],[\"AXUpgrade\",\"Aprus Upgrade\",\"适配器升级\",\"APR\",\"$AprusID-1\",\"LUA\"]]",
    "template": "{\"id\":1}",
    "reference": "参考号123",
    "created_by": 1,
    "last_modified_by": 1,
    "is_available": 1
}' http://192.168.88.202:8011/mapping/api

响应示例：

{
    "resp": "create_control",
    "actionid": "123455",
    "code": 200,
    "msg": "成功",
    "result": {
        "uid": "CTL1322264700004",
        "name": "control1"
    }
}

更新控制码

请求参数：

参数名称 是否必选 数据类型 描述
action 是 string 指令
actionid 否 string 指令编号
organization_id 否 string 组织ID
uid 是 string 控制码唯一编号
name 是 string 控制码编号
description 否 string 控制码描述
script 是 string 控制码脚本
template 否 string 控制码模板
reference 否 string 参考号
created_by 是 int 创建人
last_modified_by 是 int 更新人
is_available 是 int 是否生效

响应参数：

参数名称 数据类型 描述
resp string 返回指令
actionid string 返回指令编号
code int 返回码
msg string 提示消息
info string 详细信息
result object 返回结果

请求示例：

curl -H "Content-Type: application/json" -X POST -d '{
    "action": "update_control",
    "actionid": "123455",
    "uid": "CTL1322264700004",
    "name": "control2",
    "description": "control number 2",
    "script": "[[\"S001\",\"\",\"模拟变量1\",\"OBJ\",\"$AprusID-1.L1_3_8\",\"\"],[\"S002\",\"\",\"模拟变量2\",\"OBJ\",\"$AprusID-1.L1_3_9\",\"\"],[\"AXUpgrade\",\"Aprus Upgrade\",\"适配器升级\",\"APR\",\"$AprusID-1\",\"LUA\"]]",
    "template": "{\"id\":1}",
    "reference": "参考号123",
    "created_by": 1,
    "last_modified_by": 1,
    "is_available": 1
}' http://192.168.88.202:8011/mapping/api

响应示例：

{
    "resp": "update_control",
    "actionid": "123455",
    "code": 200,
    "msg": "成功"
}

删除控制码

请求参数：

参数名称 是否必选 数据类型 描述
action 是 string 指令
actionid 否 string 指令编号
uid 是 string 控制码唯一编号

响应参数：

参数名称 数据类型 描述
resp string 返回指令
actionid string 返回指令编号
code int 返回码
msg string 提示消息
info string 详细信息
result object 返回结果

请求示例：

curl -H "Content-Type: application/json" -X POST -d '{
    "action": "delete_control",
    "actionid": "12345",
    "uid": "CTL1322264700004"
}' http://192.168.88.202:8011/mapping/api

响应示例：

{
    "resp": "delete_control",
    "actionid": "12345",
    "code": 200,
    "msg": "成功"
}

控制码详情

请求参数：

参数名称 是否必选 数据类型 描述
action 是 string 指令
actionid 否 string 指令编号
uid 是 string 控制码唯一编号

响应参数：

参数名称 数据类型 描述
resp string 返回指令
actionid string 返回指令编号
code int 返回码
msg string 提示消息
info string 详细信息
result object 返回结果

object：

参数名称 数据类型 描述
action string 指令
actionid string 指令编号
organization_id string 组织ID
uid string 控制码唯一编号
name string 控制码编号
description string 控制码描述
script []array 控制码脚本
template object 控制码模板
reference string 参考号
created string 创建时间
created_by int 创建人
last_modified string 更新时间
last_modified_by int 更新人
is_available int 是否生效

请求示例：

curl -H "Content-Type: application/json" -X POST -d '{
    "action": "get_control_item",
    "actionid": "123456",
    "uid": "CTL1322264700004"
}' http://192.168.88.202:8011/mapping/api

响应示例：

{
    "resp": "get_control_item",
    "actionid": "123456",
    "code": 200,
    "msg": "成功",
    "result": {
        "id": 1006,
        "uid": "CTL1235832900001",
        "name": "control1",
        "description": "control number 1",
        "script": [
            [
                "S001",
                "",
                "模拟变量1",
                "OBJ",
                "$AprusID-1.L1_3_8",
                ""
            ],
            [
                "S002",
                "",
                "模拟变量2",
                "OBJ",
                "$AprusID-1.L1_3_9",
                ""
            ],
            [
                "AXUpgrade",
                "Aprus Upgrade",
                "适配器升级",
                "APR",
                "$AprusID-1",
                "LUA"
            ]
        ],
        "template": {
            "id": 1
        },
        "reference": "参考号123",
        "created": "2021-02-23 15:07:58",
        "created_by": 1,
        "last_modified": "2021-02-23 15:07:58",
        "last_modified_by": 1,
        "is_available": 1
    }
}

控制码列表

请求参数：

参数名称 是否必选 数据类型 描述
action 是 string 指令
actionid 否 string 指令编号

响应参数：

参数名称 数据类型 描述
resp string 返回指令
actionid string 返回指令编号
code int 返回码
msg string 提示消息
info string 详细信息
result []object 返回结果

object：

参数名称 数据类型 描述
action string 指令
actionid string 指令编号
organization_id string 组织ID
uid string 控制码唯一编号
name string 控制码编号
description string 控制码描述
script []array 控制码脚本
template object 控制码模板
reference string 参考号
created string 创建时间
created_by int 创建人
last_modified string 更新时间
last_modified_by int 更新人
is_available int 是否生效

请求示例：

curl -H "Content-Type: application/json" -X POST -d '{
    "action": "get_control_list",
    "actionid": "12345"
}' http://192.168.88.202:8011/mapping/api

响应示例：

{
    "resp": "get_control_list",
    "actionid": "12345",
    "code": 200,
    "msg": "成功",
    "result": [
        {
            "id": 1006,
            "uid": "CTL1235832900001",
            "name": "control1",
            "description": "control number 1",
            "script": [
                [
                    "S001",
                    "",
                    "模拟变量1",
                    "OBJ",
                    "$AprusID-1.L1_3_8",
                    ""
                ],
                [
                    "S002",
                    "",
                    "模拟变量2",
                    "OBJ",
                    "$AprusID-1.L1_3_9",
                    ""
                ],
                [
                    "AXUpgrade",
                    "Aprus Upgrade",
                    "适配器升级",
                    "APR",
                    "$AprusID-1",
                    "LUA"
                ]
            ],
            "template": {
                "id": 1
            },
            "reference": "参考号123",
            "created": "2021-02-23 15:07:58",
            "created_by": 1,
            "last_modified": "2021-02-23 15:07:58",
            "last_modified_by": 1,
            "is_available": 1
        }
    ]
}

其他指令

对象编号列表

请求参数：

参数名称 是否必选 数据类型 描述
action 是 string 指令
actionid 否 string 指令编号
mapping_id 是 string 映射表编号

响应参数：

参数名称 数据类型 描述
resp string 返回指令
actionid string 返回指令编号
code int 返回码
msg string 提示消息
info string 详细信息
result object 返回结果

请求示例：

curl -H "Content-Type: application/json" -X POST -d '{
    "action": "get_objectids_by_mappingid",
    "mapping_id": "MAP1212994600001"
}' http://192.168.88.202:8011/mapping/api

响应示例：

{
    "resp": "get_objectids_by_mappingid",
    "code": 200,
    "msg": "成功",
    "result": [
        "OBJ1243475500001",
        "OBJ1312304800002",
        "OBJ1315157900003",
        "OBJ1315925700001",
        "OBJ1315495000001",
        "OBJ1310573400002"
    ]
}

离线编号列表

请求参数：

参数名称 是否必选 数据类型 描述
action 是 string 指令
actionid 否 string 指令编号
collect_id 是 string 离线编号

响应参数：

参数名称 数据类型 描述
resp string 返回指令
actionid string 返回指令编号
code int 返回码
msg string 提示消息
info string 详细信息
result object 返回结果

请求示例：

curl -H "Content-Type: application/json" -X POST -d '{
    "action": "get_objectids_by_collectid",
    "collect_id": "COL1212994600001"
}' http://192.168.88.202:8011/mapping/api

响应示例：

{
    "resp": "get_objectids_by_collectid",
    "code": 200,
    "msg": "成功",
    "result": [
        "OBJ1243475500001",
        "OBJ1312304800002",
        "OBJ1315157900003",
        "OBJ1315925700001",
        "OBJ1315495000001",
        "OBJ1310573400002"
    ]
}

获取mosaic cluster 对应的对象列表

请求参数：

参数名称 是否必选 数据类型 描述
action 是 string 指令 get_mosaic_object_map
actionid 否 string 指令编号

响应示例：

{
    "resp": "get_mosaic_object_map",
    "code": 200,
    "msg": "成功",
    "result": {
        "192.168.1.43:6067": [
            "OBJ1006",
            "OBJ1007",
            "OBJ1008"
        ],
        "192.168.1.56:6067": [
            "OBJ3233123000002",
            "OBJ3235418400006",
            "yjj"
        ]
    }
}

Event列表

映射表事件

创建映射表事件

{
    "event": "create_mapping",
    "block": "mapping",
    "uniqueid": "PUB1323431200006",
    "datetime": "2021-03-12 16:15:34",
    "uid": "MAP1323431200006",
    "name": "mapping1"
}

更新映射表事件

{
    "event": "update_mapping",
    "block": "mapping",
    "uniqueid": "PUB1323431200006",
    "datetime": "2021-03-12 16:15:34",
    "uid": "MAP1323431200006",
    "name": "mapping1"
}

删除映射表事件

{
    "event": "delete_mapping",
    "block": "mapping",
    "uniqueid": "PUB1323431200006",
    "datetime": "2021-03-12 16:15:34",
    "uid": "MAP1323431200006",
    "name": "AX001"
}

对象事件

创建对象事件

{
    "event": "create_object",
    "block": "mapping",
    "uniqueid": "PUB1321207800001",
    "datetime": "2021-03-12 16:15:34",
    "uid": "OBJ1321207800001",
    "name": "object1"
}

更新对象事件

{
    "event": "update_object",
    "block": "mapping",
    "uniqueid": "PUB1321207800001",
    "datetime": "2021-03-12 16:15:34",
    "uid": "OBJ1321207800001",
    "name": "object1"
}

删除对象事件

{
    "event": "delete_object",
    "block": "mapping",
    "uniqueid": "PUB1321207800001",
    "datetime": "2021-03-12 16:15:34",
    "uid": "OBJ1321207800001",
    "name": "AX001"
}

控制表事件

创建控制表事件

{
    "event": "create_control",
    "block": "mapping",
    "uniqueid": "PUB1321207800001",
    "datetime": "2021-03-12 16:15:34",
    "uid": "CTL1321207800001",
    "name": "control1"
}

更新控制表事件

{
    "event": "update_control",
    "block": "mapping",
    "uniqueid": "PUB1321207800001",
    "datetime": "2021-03-12 16:15:34",
    "uid": "CTL1321207800001",
    "name": "control2"
}

删除控制表事件

{
    "event": "delete_control",
    "block": "mapping",
    "uniqueid": "PUB1321207800001",
    "datetime": "2021-03-12 16:15:34",
    "uid": "CTL1321207800001",
    "name": "AX001"
}

Pusher action 说明

发送控制码指令

向对象发布对象配置好的控制码指令

  • 参数
参数名称 是否必选 数据类型 数据约束 描述
action 是 String publish_command 方法名
actionid 否 String 活动标识
object_id 是 String 对象id
command 是 String 控制码指令
value 否 String 控制值
  • 示例
{
    "action": "publish_command",
    "object_id": "OBJ1243475500001",
    "command": "Control_01", // 对应控制码脚本中的第一列
    "value": "1"
}
  • 响应
{
    "resp": "publishe_command",
    "actionid": "",
    "code": 200,
    "msg": "成功",
    "result": {}
}

批量发送控制码指令

向对象发布多条对象配置好的控制码指令

  • 参数
参数名称 是否必选 数据类型 数据约束 描述
action 是 String publishe_command_plus 方法名
actionid 否 String 活动标识
publishes 是 List 控制列表
+object_id 是 String 对象id
+command 是 String 控制码指令
+value 否 String 控制值
  • 示例
{
    "action": "publishe_command_plus",
    "publishes": [
        {
            "object_id": "OBJ1243475500001",
            "command": "Control_01", // 对应控制码脚本中的第一列
            "value": "1"
        }, 
        {
            "object_id": "OBJ1243475500002",
            "command": "Control_01", // 对应控制码脚本中的第一列
            "value": "1"
        }, 
    ]
}
  • 响应
{
    "resp": "publishe_command_plus",
    "actionid": "",
    "code": 200,
    "msg": "成功",
    "result": {}
}

直接向终端发送控制指令

直接向终端发送控制指令

  • 参数
参数名称 是否必选 数据类型 数据约束 描述
action 是 String publishe_terminal_command 方法名
actionid 否 String 活动标识
terminal_id 是 String 终端id
command 是 String 控制码指令
value 否 String 控制值
  • 示例
{
    "action": "publish_terminal_command",
    "terminal_id": "AX1001",
    "command": "AXUpgrade", // 对应控制码脚本中的第一列
    "value": "LUA"
}
  • 响应
{
    "resp": "publishe_command_plus",
    "actionid": "",
    "code": 200,
    "msg": "成功",
    "result": {}
}

获取 Pusher 开关状态

获取 Pusher 是否开启，如果没有开启，所有的指令下发都会被拒绝

  • 参数
参数名称 是否必选 数据类型 数据约束 描述
action 是 String get_enable 方法名
  • 示例
{
    "action": "get_enable"
}
  • 响应
{
    "resp": "get_enable",
    "code": 200,
    "msg": "成功",
    "result": {
        "enable": true
    }
}

设置 Pusher 开关

设置 Pusher 开启或关闭

  • 参数
参数名称 是否必选 数据类型 数据约束 描述
action 是 String get_enable 方法名
enable 是 Bool 开关布尔值
  • 示例
{
    "action": "set_enable",
    "enable": true
}
  • 响应
{
    "resp": "set_enable",
    "code": 200,
    "msg": "成功",
    "result": {
        "enable": true
    }
}
文档更新时间: 2024-08-08 19:26   作者：技术支持