场景中心

1 git

1.1 git URL

http://10.18.69.218/smartx/smart-cmty/iot-main-scene.git

1.2 开发分支： develop

2 项目包名规范

包路径	说明
com.mideazy.smart.iot.scene	spring-boot项目主路径
com.mideazy.smart.iot.scene.entity	存放mongoDB 文档型实体
com.mideazy.smart.iot.scene.config	存放java config配置
com.mideazy.smart.iot.scene.repository	存放Spring-data-mongoDB 接口
com.mideazy.smart.iot.scene.constants	存放常量、枚举类
com.mideazy.smart.iot.scene.tools	存入工具类
com.mideazy.smart.iot.scene.service	存放服务类，实现具体业务逻辑
com.mideazy.smart.iot.scene.form	存放普通java bean
com.mideazy.smart.iot.scene.controller	存放restfull API 接口类，netty 无状态服务

1 消息模板定义

1.1 新增消息模板

URL：/v1/scene/messageTemplateInfo/insertMessageTemplateInfo

方法：POST

请求参数

名称	位置	类型	必填	描述
id	body	String	n	主键id(自动生成)
name	body	String	y	消息模板名
type	body	String	y	消息类型(事件消息及非事件消息)
title	body	String	y	消息标题
content	body	String	y	消息内容
redirectUrl	body	String	n	跳转连接
messageTemplateRefParamDtos	body	List	n	消息模板引用参数[集合],只有事件消息,才可能有引用参数
paramCnName	messageTemplateRefParamDtos	String	n	变量中文名
authOrgId	body	Long	y	业务组织id（左上角指定的业务组织）用于获取顶级组织来做数据隔离

请求Body描述(非Form表单数据)

{
    "name" : "系统繁忙事件消息",
    "type" : "事件消息",
    "title" : "系统繁忙",
    "content" : "@{设备名称}系统繁忙,请稍后重试!",
    "redirectUrl" : "https://sit-iot-manage.smartmideazy.com/#/apply-authorize/authorize-list?fromLogin=true",
    "messageTemplateRefParamDtos" : [
        {
            "paramCnName" : "设备名称"
        }
    ]
}

返回信息 (会把刚存储的记录返回)

返回参数类型

JSON

返回参数

字段	字段类型	是否必填	说明
id	String	y	主键id(自动生成)
name	String	y	消息模板名
type	String	y	消息类型(事件消息及非事件消息)
title	String	y	消息标题
content	String	y	消息内容
redirectUrl	String	y	跳转连接
messageTemplateRefParamDtos	List	y	消息模板引用参数[集合],只有事件消息,才有引用参数
paramCnName	messageTemplateRefParamDtos	y	变量中文名
topBusinessOrgId	Long	y	顶级组织

返回示例：

{
    "code": "200",
    "message": "成功",
    "version": null,
    "result": {
        "id": "60323091bd53814fb067452a",
        "name": "系统繁忙事件消息",
        "type": "事件消息",
        "title": "系统繁忙",
        "content": "@{设备名称}系统繁忙,请稍后重试!",
        "redirectUrl": "https://sit-iot-manage.smartmideazy.com/#/apply-authorize/authorize-list?fromLogin=true",
        "messageTemplateRefParamDtos": [
            {
                "paramCnName": "设备名称"
            }
        ]
    }
}

1.2修改消息模板

URL：/v1/scene/messageTemplateInfo/updateMessageTemplateInfo

方法：POST

请求参数

名称	位置	类型	必填	描述
id	body	String	y	主键id
name	body	String	y	消息模板名
type	body	String	y	消息类型(事件消息及非事件消息)
title	body	String	y	消息标题
content	body	String	y	消息内容
redirectUrl	body	String	n	跳转连接
messageTemplateRefParamDtos	body	List	n	消息模板引用参数[集合],只有事件消息,才可能有引用参数
paramCnName	messageTemplateRefParamDtos	String	n	变量中文名
authOrgId	body	Long		业务组织id（左上角指定的业务组织）用于获取顶级组织来做数据隔离

请求Body描述(非Form表单数据)

{
    "id": "60323091bd53814fb067452a",
    "name" : "系统繁忙事件消息",
    "type" : "事件消息",
    "title" : "系统繁忙",
    "content" : "@{设备名称}系统繁忙,请稍后重试!",
    "redirectUrl" : "https://sit-iot-manage.smartmideazy.com/#/apply-authorize/authorize-list?fromLogin=true",
    "messageTemplateRefParamDtos" : [
        {
            "paramCnName" : "设备名称"
        }
    ]
}

返回信息 (会把刚存储的记录返回)

返回参数类型

JSON

返回参数

字段	字段类型	是否必填	说明
id	String	y	主键id(自动生成)
name	String	y	消息模板名
type	String	y	消息类型(事件消息及非事件消息)
title	String	y	消息标题
content	String	y	消息内容
redirectUrl	String	y	跳转连接
messageTemplateRefParamDtos	List	y	消息模板引用参数[集合],只有事件消息,才有引用参数
paramCnName	messageTemplateRefParamDtos	y	变量中文名

返回示例：

{
    "code": "200",
    "message": "成功",
    "version": null,
    "result": {
        "id": "60323091bd53814fb067452a",
        "name": "系统繁忙事件消息",
        "type": "事件消息",
        "title": "系统繁忙",
        "content": "@{设备名称}系统繁忙,请稍后重试!",
        "redirectUrl": "https://sit-iot-manage.smartmideazy.com/#/apply-authorize/authorize-list?fromLogin=true",
        "messageTemplateRefParamDtos": [
            {
                "paramCnName": "设备名称"
            }
        ]
    }
}

1.3删除消息模板(删除失败,会返回引用该消息模板的,消息实例)

URL：/v1/scene/messageTemplateInfo/deleteMessageTemplateInfo

方法：POST

请求参数

名称	位置	类型	必填	描述
id	body	String	y	主键id(只输入id也可以)
name	body	String	n	消息模板名
type	body	String	n	消息类型(事件消息及非事件消息)
title	body	String	n	消息标题
content	body	String	n	消息内容
redirectUrl	body	String	n	跳转连接
messageTemplateRefParamDtos	body	List	n	消息模板引用参数[集合],只有事件消息,才有引用参数
id	messageTemplateRefParamDtos	String	n	主键id
paramCnName	messageTemplateRefParamDtos	String	n	变量中文名
paramName	messageTemplateRefParamDtos	String	n	变量名

请求Body描述(非Form表单数据)

{
    "id": "603251d6bd538139446d9d2f",
    "name": "系统繁忙事件消息",
    "type": "非事件消息",
    "title": "系统繁忙",
    "content": "@{设备名称}系统繁忙,请稍后重试!",
    "redirectUrl": "https://sit-iot-manage.smartmideazy.com/#/apply-authorize/authorize-list?fromLogin=true",
    "messageTemplateRefParamDtos": [
        {
            "paramCnName": "设备名称"
        }
    ]
}

返回信息

返回参数类型

JSON

返回参数

字段	字段类型	是否必填	说明
code	String	y	响应码
message	String	n	返回信息
version	String	n	版本
result	String	n	返回数据

返回示例：


删除成功时,返回的JSON
{
    "code": "200",
    "message": "成功",
    "version": null,
    "result": null
}

删除失败时,返回的JSON
{
    "code": "1009",
    "message": "异常: 不允许删除,该消息模板,被以下消息实例引用",
    "version": null,
    "result": {
        "id": "6038fdc5bd538146a475e56d",
        "topBusinessOrgId": 15266,
        "messageTemplateInfoType": "事件消息",
        "messageConfigName": "消防警报消息",
        "messageTemplateInfoId": "603251d6bd538139446d9d2f",
        "enable": 1,
        "messageTerminalDtos": [
            {
                "id": "20210226215517030445e31c84ed24738a1cfbe593b3c96e9",
                "terminalType": "管家APP",
                "pushMode": "弹框,toast,系统消息,消息中心",
                "terminalOrgAdminDtos": [
                    {
                        "orgId": 247416,
                        "orgName": "美的集团",
                        "adminGroupDtos": [
                            {
                                "groupId": 789578,
                                "groupName": "院长组",
                                "groupEmployeeDtos": [
                                    {
                                        "personId": 564552,
                                        "personName": "邓仕英"
                                    }
                                ]
                            }
                        ]
                    }
                ],
                "terminalOrgCustomerDtos": null
            }
        ]
    }
}

1.4查询所有消息模板(支持分页)

URL：/v1/scene/messageTemplateInfo/findAllMessageTemplateInfos

方法：POST

请求参数

名称	位置	类型	必填	描述
pageNo	body	String	y	当前页码
pageSize	body	String	y	页面大小
authOrgId	body	Long	y	业务组织id（左上角指定的业务组织）用于获取顶级组织来做数据隔离

请求Body描述(非Form表单数据)

{
   "pageNo" : "1",
   "pageSize" : "5"
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
id	body	String	y	主键id
name	body	String	y	消息模板名
type	body	String	y	消息类型(事件消息及非事件消息)
title	body	String	y	消息标题
content	body	String	y	消息内容
redirectUrl	body	String	y	跳转连接
messageTemplateRefParamDtos	body	List	y	消息模板引用参数[集合],只有事件消息,才有引用参数
id	messageTemplateRefParamDtos	String	y	主键id
paramCnName	messageTemplateRefParamDtos	String	y	变量中文名
paramName	messageTemplateRefParamDtos	String	y	变量名
total	body	String	y	总记录数
totalPage	body	String	y	分页总数

返回示例：

{
    "code": "200",
    "message": "成功",
    "version": null,
    "result": [
        {
            "id": "60322e5abd53814fb0674527",
            "name": "防汛警报事件消息",
            "type": "事件消息",
            "title": "防汛警报",
            "content": "@{设备名称}:@{设备ID},有洪水泛滥隐患,请及时处理!",
            "redirectUrl": "https://sit-iot-manage.smartmideazy.com/#/apply-authorize/authorize-list?fromLogin=true",
            "messageTemplateRefParamDtos": [
                {
                    "id": "b0789aecba15407dbcba5512e872877720210221175642283",
                    "paramCnName": "设备名称",
                    "paramName": "deviceName"
                },
                {
                    "id": "da0dc95c043c48c2bea65defb557b62120210221175642285",
                    "paramCnName": "设备ID",
                    "paramName": "deviceId"
                },
                {
                    "id": "c6bff943797742d68eff611bdbbd82e720210221175642285",
                    "paramCnName": "MAC地址",
                    "paramName": "macAddress"
                }
            ]
        },
        {
            "id": "60322ec5bd53814fb0674528",
            "name": "消防警报事件消息",
            "type": "事件消息",
            "title": "消防警报",
            "content": "@{设备名称}:@{设备ID},有火灾隐患,请及时处理!",
            "redirectUrl": "https://sit-iot-manage.smartmideazy.com/#/apply-authorize/authorize-list?fromLogin=true",
            "messageTemplateRefParamDtos": [
                {
                    "id": "7bb6a69d82224b0db164159565d5788620210221175829087",
                    "paramCnName": "设备名称",
                    "paramName": "deviceName"
                },
                {
                    "id": "278bc609a22a4faf93598dd2952f056620210221175829087",
                    "paramCnName": "设备ID",
                    "paramName": "deviceId"
                }
            ]
        },
        {
            "id": "60323091bd53814fb067452a",
            "name": "系统繁忙事件消息",
            "type": "事件消息",
            "title": "系统繁忙",
            "content": "@{设备名称}系统繁忙,请稍后重试!",
            "redirectUrl": "https://sit-iot-manage.smartmideazy.com/#/apply-authorize/authorize-list?fromLogin=true",
            "messageTemplateRefParamDtos": [
                {
                    "id": "7fee38963d7c4aa68b047f792f456c7d20210221180609815",
                    "paramCnName": "设备名称",
                    "paramName": "deviceName"
                }
            ]
        },
        {
            "id": "6032576bbd53814828830882",
            "name": "测试系统繁忙事件消息1",
            "type": "非事件消息",
            "title": "系统繁忙",
            "content": "@{设备名称}系统繁忙,请稍后重试!",
            "redirectUrl": "https://sit-iot-manage.smartmideazy.com/#/apply-authorize/authorize-list?fromLogin=true",
            "messageTemplateRefParamDtos": [
                {
                    "id": "817eb5115eb34f2da84506cfad76a57b20210221205155033",
                    "paramCnName": "设备名称",
                    "paramName": "deviceName"
                },
                {
                    "id": "32a5f226f5fe4b41a31fe0db7d59012420210221205155033",
                    "paramCnName": "设备ID",
                    "paramName": "deviceId"
                }
            ]
        },
        {
            "id": "6032578abd53814828830883",
            "name": "测试系统繁忙事件消息2",
            "type": "事件消息",
            "title": "系统繁忙",
            "content": "@{设备名称}系统繁忙,请稍后重试!",
            "redirectUrl": "https://sit-iot-manage.smartmideazy.com/#/apply-authorize/authorize-list?fromLogin=true",
            "messageTemplateRefParamDtos": [
                {
                    "id": "83f7f283acf4480491042a88b0ef0fd620210221205226072",
                    "paramCnName": "设备名称",
                    "paramName": "deviceName"
                },
                {
                    "id": "f2f2a94197d74aff820c63e73679a71220210221205226072",
                    "paramCnName": "设备ID",
                    "paramName": "deviceId"
                }
            ]
        }
    ],
    "pageNo": 0,
    "pageSize": 0,
    "total": 23,
    "totalPage": 5
}

1.5根据消息类型(精确查询),消息模板名称(全模糊查询),查询消息模板(支持分页)

URL：/v1/scene/messageTemplateInfo/findMessageTemplateInfoByTypeOrLikeName

方法：POST

请求参数

名称	位置	类型	必填	描述
pageNo	body	String	y	当前页码
pageSize	body	String	y	页面大小
type	body	String	n	消息类型(事件消息及非事件消息)(type与name,不能同时为空)
name	body	String	n	消息模板名称(type与name,不能同时为空)
authOrgId	body	Long	y	业务组织id（左上角指定的业务组织）用于获取顶级组织来做数据隔离

请求Body描述(非Form表单数据)

{
   "pageNo" : "1",
   "pageSize" : "5",
    "type" : "事件消息",
    "name" : "测试系统繁忙事件消息"
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
id	body	String	y	主键id(只输入id也可以)
name	body	String	y	消息模板名
type	body	String	y	消息类型(事件消息及非事件消息)
title	body	String	y	消息标题
content	body	String	y	消息内容
redirectUrl	body	String	y	跳转连接
messageTemplateRefParamDtos	body	List	y	消息模板引用参数[集合],只有事件消息,才有引用参数
id	messageTemplateRefParamDtos	String	y	主键id
paramCnName	messageTemplateRefParamDtos	String	y	变量中文名
paramName	messageTemplateRefParamDtos	String	y	变量名
total	body	String	y	总记录数
totalPage	body	String	y	分页总数

返回示例：

{
    "code": "200",
    "message": "成功",
    "version": null,
    "result": [
        {
            "id": "60322e5abd53814fb0674527",
            "name": "测试系统繁忙事件消息10",
            "type": "事件消息",
            "title": "防汛警报",
            "content": "@{设备名称}:@{设备ID},有洪水泛滥隐患,请及时处理!",
            "redirectUrl": "https://sit-iot-manage.smartmideazy.com/#/apply-authorize/authorize-list?fromLogin=true",
            "messageTemplateRefParamDtos": [
                {
                    "id": "b0789aecba15407dbcba5512e872877720210221175642283",
                    "paramCnName": "设备名称",
                    "paramName": "deviceName"
                },
                {
                    "id": "da0dc95c043c48c2bea65defb557b62120210221175642285",
                    "paramCnName": "设备ID",
                    "paramName": "deviceId"
                },
                {
                    "id": "c6bff943797742d68eff611bdbbd82e720210221175642285",
                    "paramCnName": "MAC地址",
                    "paramName": "macAddress"
                }
            ]
        },
        {
            "id": "60322ec5bd53814fb0674528",
            "name": "测试系统繁忙事件消息9",
            "type": "事件消息",
            "title": "消防警报",
            "content": "@{设备名称}:@{设备ID},有火灾隐患,请及时处理!",
            "redirectUrl": "https://sit-iot-manage.smartmideazy.com/#/apply-authorize/authorize-list?fromLogin=true",
            "messageTemplateRefParamDtos": [
                {
                    "id": "7bb6a69d82224b0db164159565d5788620210221175829087",
                    "paramCnName": "设备名称",
                    "paramName": "deviceName"
                },
                {
                    "id": "278bc609a22a4faf93598dd2952f056620210221175829087",
                    "paramCnName": "设备ID",
                    "paramName": "deviceId"
                }
            ]
        },
        {
            "id": "60323091bd53814fb067452a",
            "name": "测试系统繁忙事件消息8",
            "type": "事件消息",
            "title": "系统繁忙",
            "content": "@{设备名称}系统繁忙,请稍后重试!",
            "redirectUrl": "https://sit-iot-manage.smartmideazy.com/#/apply-authorize/authorize-list?fromLogin=true",
            "messageTemplateRefParamDtos": [
                {
                    "id": "7fee38963d7c4aa68b047f792f456c7d20210221180609815",
                    "paramCnName": "设备名称",
                    "paramName": "deviceName"
                }
            ]
        },
        {
            "id": "6032576bbd53814828830882",
            "name": "测试系统繁忙事件消息7",
            "type": "非事件消息",
            "title": "系统繁忙",
            "content": "@{设备名称}系统繁忙,请稍后重试!",
            "redirectUrl": "https://sit-iot-manage.smartmideazy.com/#/apply-authorize/authorize-list?fromLogin=true",
            "messageTemplateRefParamDtos": [
                {
                    "id": "817eb5115eb34f2da84506cfad76a57b20210221205155033",
                    "paramCnName": "设备名称",
                    "paramName": "deviceName"
                },
                {
                    "id": "32a5f226f5fe4b41a31fe0db7d59012420210221205155033",
                    "paramCnName": "设备ID",
                    "paramName": "deviceId"
                }
            ]
        },
        {
            "id": "6032578abd53814828830883",
            "name": "测试系统繁忙事件消息6",
            "type": "事件消息",
            "title": "系统繁忙",
            "content": "@{设备名称}系统繁忙,请稍后重试!",
            "redirectUrl": "https://sit-iot-manage.smartmideazy.com/#/apply-authorize/authorize-list?fromLogin=true",
            "messageTemplateRefParamDtos": [
                {
                    "id": "83f7f283acf4480491042a88b0ef0fd620210221205226072",
                    "paramCnName": "设备名称",
                    "paramName": "deviceName"
                },
                {
                    "id": "f2f2a94197d74aff820c63e73679a71220210221205226072",
                    "paramCnName": "设备ID",
                    "paramName": "deviceId"
                }
            ]
        }
    ],
    "pageNo": 0,
    "pageSize": 0,
    "total": 23,
    "totalPage": 5
}

1.6根据消息模板id,查询消息模板详情

URL：/v1/scene/messageTemplateInfo/findMessageTemplateInfoById

方法：POST

请求参数

名称	位置	类型	必填	描述
id	body	String	y	消息模板id

请求Body描述(非Form表单数据)

{
   "id" : "60322e5abd53814fb0674527"
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
id	body	String	y	主键id(只输入id也可以)
name	body	String	y	消息模板名
type	body	String	y	消息类型(事件消息及非事件消息)
title	body	String	y	消息标题
content	body	String	y	消息内容
redirectUrl	body	String	y	跳转连接
messageTemplateRefParamDtos	body	List	y	消息模板引用参数[集合],只有事件消息,才有引用参数
id	messageTemplateRefParamDtos	String	y	主键id
paramCnName	messageTemplateRefParamDtos	String	y	变量中文名
paramName	messageTemplateRefParamDtos	String	y	变量名
total	body	String	y	总记录数
totalPage	body	String	y	分页总数

返回示例：

{
    "code": "200",
    "message": "成功",
    "version": null,
    "result":
        {
            "id": "60322e5abd53814fb0674527",
            "name": "测试系统繁忙事件消息10",
            "type": "事件消息",
            "title": "防汛警报",
            "content": "@{设备名称}:@{设备ID},有洪水泛滥隐患,请及时处理!",
            "redirectUrl": "https://sit-iot-manage.smartmideazy.com/#/apply-authorize/authorize-list?fromLogin=true",
            "messageTemplateRefParamDtos": [
                {
                    "id": "b0789aecba15407dbcba5512e872877720210221175642283",
                    "paramCnName": "设备名称",
                    "paramName": "deviceName"
                },
                {
                    "id": "da0dc95c043c48c2bea65defb557b62120210221175642285",
                    "paramCnName": "设备ID",
                    "paramName": "deviceId"
                },
                {
                    "id": "c6bff943797742d68eff611bdbbd82e720210221175642285",
                    "paramCnName": "MAC地址",
                    "paramName": "macAddress"
                }
            ]
        }       
}

2 运行结果-消息实例定义

2.1 新增消息实例

URL：/v1/scene/messageConfig/insertMessageConfig

方法：POST

请求参数

名称	位置	类型	必填	描述
authBusinessOrgId	body	Long	y	页面左上角用于数据控制的业务组织id
messageTemplateInfoType	body	String	y	消息模板类型(事件消息及非事件消息)
messageConfigName	body	String	y	消息实例名称
messageTemplateInfoId	body	String	y	消息模板id
messageTerminalDtos	body	List	y	消息接收终端[集合]
terminalType	messageTerminalDtos	String	y	终端类型-单选(IOC;后台;社区APP;管家APP)
pushModes	messageTerminalDtos	List	y	消息推送方式-支持多选(弹框,toast,系统消息,消息中心)，用集合传过来
relSpaces	messageTerminalDtos	List	n	接收者-空间集合(终端类型是:社区APP时,必填,且只能选空间)
customerSelectMode	terminalOrgCustomerDtos	Integer	y	客户选择模式(1:项目; 2:房屋)
projectId	terminalOrgCustomerDtos	Long	n	项目id(当客户选择模式为:2:房屋时,必填)
spaceId	customerSpaceDtos	Long	y	空间id
spaceType	customerSpaceDtos	String	y	空间类型
relGroups	messageTerminalDtos	List	n	接收者-分组(终端类型是[IOC;后台;管家APP]其中一种时,必填,且只能选分组)
orgId	relGroups	Long	y	业务组织id
groupId	relGroups	Long	y	员工分组id

请求Body描述(非Form表单数据)

{
    "authBusinessOrgId": 15266,
    "messageTemplateInfoType": "事件消息",
    "messageConfigName": "消防警报消息",
    "messageTemplateInfoId": "60322ec5bd53814fb0674528",
    "messageTerminalDtos": [
        {
            "terminalType": "管家APP",
            "pushModes": ["弹框","toast","系统消息","消息中心"],
            "relGroups": [
                {
                    "orgId": 247416,
                    "groupId": 789578
                },
                 {
                    "orgId": 247417,
                    "groupId": 789579
                }  
            ],
            "relSpaces":[
                {
                    "customerSelectMode":1,
                    "spaceId":12345,
                    "spaceType":"COMMUNITY"
                },
                {
                    "customerSelectMode":2,
                    "projectId":123,
                    "spaceId":12345,
                    "spaceType":"HOUSE"
                }
            ]
        }
    ]
}

返回信息 (把刚存储的记录返回)

返回参数类型

JSON

返回参数

名称	位置	类型	描述
id	body	String	主键id
authBusinessOrgId	body	Long	页面左上角用于数据控制的业务组织id
messageTemplateInfoType	body	String	消息模板类型(事件消息及非事件消息)
messageConfigName	body	String	消息实例名称
messageTemplateInfoId	body	String	消息模板id
enable	body	Integer	是否启用消息配置(默认1:启用; 2:禁用)
messageTerminalDtos	body	List	消息接收终端[集合]
updateTime	body	TIME	最新更新时间
messageTerminalId	messageTerminalDtos	String	终端id
terminalType	messageTerminalDtos	String	终端类型-单选(IOC;后台;社区APP;管家APP)
pushModes	messageTerminalDtos	List	消息推送方式-支持多选(弹框,toast,系统消息,消息中心)，用集合传过来
relSpaces	messageTerminalDtos	List	接收者-空间集合(终端类型是:社区APP时,必填,且只能选空间)
customerSelectMode	terminalOrgCustomerDtos	Integer	客户选择模式(1:项目; 2:房屋)
projectId	terminalOrgCustomerDtos	Long	项目id(当客户选择模式为:2:房屋时,必填)
projectName	terminalOrgCustomerDtos	String	项目名
spaceId	customerSpaceDtos	Long	空间id
fullSpaceName	customerSpaceDtos	String	空间全路径名
assambleName	customerSpaceDtos	String	页面显示的组合名称
spaceType	customerSpaceDtos	String	空间类型
relGroups	messageTerminalDtos	List	接收者-分组(终端类型是[IOC;后台;管家APP]其中一种时,必填,且只能选分组)
orgId	relGroups	Long	业务组织id
orgName	relGroups	String	业务组织名
groupId	relGroups	Long	员工分组id
groupName	relGroups	String	员工分组名

返回示例：

{
    "code": "200",
    "message": "成功",
    "version": null,
    "result": {
        "createTime": null,
        "updateTime": null,
        "createBy": null,
        "updateBy": null,
        "id": "604303117c7e1130f4f523d8",
        "topBusinessOrgId": 21897,
        "authBusinessOrgId": 21897,
        "messageTemplateInfoType": "非事件消息",
        "messageConfigName": "测试系统繁忙事件消息20-实例1-修改1",
        "messageTemplateInfoId": "603258bfbd53814828830895",
        "enable": null,
        "messageTerminalDtos": [
            {
                "messageTerminalId": "20210306122032953fb013219659c45e1a5c4fda4d741defb",
                "terminalType": "IOC",
                "pushModes": [
                    "弹框",
                    "消息日志"
                ],
                "relGroups": [
                    {
                        "groupId": 27478,
                        "groupName": "云景清洁队11",
                        "orgId": 26211,
                        "orgName": "云景业务"
                    }
                ],
                "relSpaces": null
            },
            {
                "messageTerminalId": "20210306122032954f5fcf5b5153c446e8d5eee2522d49687",
                "terminalType": "后台",
                "pushModes": [
                    "弹框",
                    "消息日志",
                    "toast"
                ],
                "relGroups": [
                    {
                        "groupId": 27476,
                        "groupName": "云景消防队",
                        "orgId": 26211,
                        "orgName": "云景业务"
                    }
                ],
                "relSpaces": null
            },
            {
                "messageTerminalId": "202103061220329542cdd3853dbae4d5bb86cca1ce565760e",
                "terminalType": "管家APP",
                "pushModes": [
                    "弹框",
                    "消息日志",
                    "toast",
                    "系统消息"
                ],
                "relGroups": [
                    {
                        "groupId": 27476,
                        "groupName": "云景消防队",
                        "orgId": 26211,
                        "orgName": "云景业务"
                    }
                ],
                "relSpaces": null
            },
            {
                "messageTerminalId": "20210306122032954373fa51b17b640c1aac5a29ce7b0b190",
                "terminalType": "社区APP",
                "pushModes": [
                    "弹框",
                    "消息日志",
                    "toast",
                    "系统消息"
                ],
                "relGroups": null,
                "relSpaces": [
                    {
                        "customerSelectMode": 1,
                        "projectId": null,
                        "projectName": null,
                        "spaceId": 23646,
                        "spaceType": "COMMUNITY",
                        "fullSpaceName": "美的置业广场体验馆",
                        "assambleName": "美的置业广场体验馆"
                    },
                    {
                        "customerSelectMode": 2,
                        "projectId": 23646,
                        "projectName": "美的置业广场体验馆",
                        "spaceId": 23665,
                        "spaceType": "HOUSE",
                        "fullSpaceName": "美的置业广场体验馆/建筑物/美的置业大楼/1单元/19/样板房",
                        "assambleName": "美的置业广场体验馆/建筑物/美的置业大楼/1单元/19/样板房"
                    }
                ]
            }
        ],
        "pageNo": null,
        "pageSize": null
    }
}

2.2 修改消息实例

URL：/v1/scene/messageConfig/updateMessageConfig

方法：POST

请求参数

名称	位置	类型	必填	描述
id	body	String	y	主键id
authBusinessOrgId	body	Long	y	页面左上角用于数据控制的业务组织id
messageTemplateInfoType	body	String	y	消息模板类型(事件消息及非事件消息)
messageConfigName	body	String	y	消息实例名称
messageTemplateInfoId	body	String	y	消息模板id
enable	body	Integer	n	是否启用消息配置(默认1:启用; 2:禁用)
messageTerminalDtos	body	List	y	消息接收终端[集合]
messageTerminalId	messageTerminalDtos	String	y	终端id
terminalType	messageTerminalDtos	String	y	终端类型-单选(IOC;后台;社区APP;管家APP)
pushModes	messageTerminalDtos	List	y	消息推送方式-支持多选(弹框,toast,系统消息,消息中心)，用集合传过来
relSpaces	messageTerminalDtos	List	n	接收者-空间集合(终端类型是:社区APP时,必填,且只能选空间)
customerSelectMode	terminalOrgCustomerDtos	Integer	y	客户选择模式(1:项目; 2:房屋)
projectId	terminalOrgCustomerDtos	Long	n	项目id(当客户选择模式为:2:房屋时,必填)
spaceId	customerSpaceDtos	Long	y	空间id
spaceType	customerSpaceDtos	String	y	空间类型
relGroups	messageTerminalDtos	List	n	接收者-分组(终端类型是[IOC;后台;管家APP]其中一种时,必填,且只能选分组)
orgId	relGroups	Long	y	业务组织id
groupId	relGroups	Long	y	员工分组id

请求Body描述(非Form表单数据)

{
    "id":"112222",
    "authBusinessOrgId": 15266,
    "messageTemplateInfoType": "事件消息",
    "messageConfigName": "消防警报消息",
    "messageTemplateInfoId": "60322ec5bd53814fb0674528",
    "messageTerminalDtos": [
        {
            "messageTerminalId":"123345ffkgkfgk",
            "terminalType": "管家APP",
            "pushModes": ["弹框","toast","系统消息","消息中心"],
            "relGroups": [
                {
                    "orgId": 247416,
                    "groupId": 789578
                },
                 {
                    "orgId": 247417,
                    "groupId": 789579
                }  
            ],
            "relSpaces":[
                {
                    "customerSelectMode":1,
                    "spaceId":12345,
                    "spaceType":"COMMUNITY"
                },
                {
                    "customerSelectMode":2,
                    "projectId":123,
                    "spaceId":12345,
                    "spaceType":"HOUSE"
                }
            ]
        }
    ]
}

返回信息 (把刚修改的记录返回)

返回参数类型

JSON

返回参数

名称	位置	类型	描述
id	body	String	主键id
authBusinessOrgId	body	Long	页面左上角用于数据控制的业务组织id
messageTemplateInfoType	body	String	消息模板类型(事件消息及非事件消息)
messageConfigName	body	String	消息实例名称
messageTemplateInfoId	body	String	消息模板id
enable	body	Integer	是否启用消息配置(默认1:启用; 2:禁用)
messageTerminalDtos	body	List	消息接收终端[集合]
updateTime	body	TIME	最新更新时间
messageTerminalId	messageTerminalDtos	String	终端id
terminalType	messageTerminalDtos	String	终端类型-单选(IOC;后台;社区APP;管家APP)
pushModes	messageTerminalDtos	List	消息推送方式-支持多选(弹框,toast,系统消息,消息中心)，用集合传过来
relSpaces	messageTerminalDtos	List	接收者-空间集合(终端类型是:社区APP时,必填,且只能选空间)
customerSelectMode	terminalOrgCustomerDtos	Integer	客户选择模式(1:项目; 2:房屋)
projectId	terminalOrgCustomerDtos	Long	项目id(当客户选择模式为:2:房屋时,必填)
projectName	terminalOrgCustomerDtos	String	项目名
spaceId	customerSpaceDtos	Long	空间id
fullSpaceName	customerSpaceDtos	String	空间全路径名
assambleName	customerSpaceDtos	String	页面显示的组合名称
spaceType	customerSpaceDtos	String	空间类型
relGroups	messageTerminalDtos	List	接收者-分组(终端类型是[IOC;后台;管家APP]其中一种时,必填,且只能选分组)
orgId	relGroups	Long	业务组织id
orgName	relGroups	String	业务组织名
groupId	relGroups	Long	员工分组id
groupName	relGroups	String	员工分组名

返回示例：

{
    "code": "200",
    "message": "成功",
    "version": null,
    "result": {
        "createTime": null,
        "updateTime": null,
        "createBy": null,
        "updateBy": null,
        "id": "604303117c7e1130f4f523d8",
        "topBusinessOrgId": 21897,
        "authBusinessOrgId": 21897,
        "messageTemplateInfoType": "非事件消息",
        "messageConfigName": "测试系统繁忙事件消息20-实例1-修改1",
        "messageTemplateInfoId": "603258bfbd53814828830895",
        "enable": null,
        "messageTerminalDtos": [
            {
                "messageTerminalId": "20210306122032953fb013219659c45e1a5c4fda4d741defb",
                "terminalType": "IOC",
                "pushModes": [
                    "弹框",
                    "消息日志"
                ],
                "relGroups": [
                    {
                        "groupId": 27478,
                        "groupName": "云景清洁队11",
                        "orgId": 26211,
                        "orgName": "云景业务"
                    }
                ],
                "relSpaces": null
            },
            {
                "messageTerminalId": "20210306122032954f5fcf5b5153c446e8d5eee2522d49687",
                "terminalType": "后台",
                "pushModes": [
                    "弹框",
                    "消息日志",
                    "toast"
                ],
                "relGroups": [
                    {
                        "groupId": 27476,
                        "groupName": "云景消防队",
                        "orgId": 26211,
                        "orgName": "云景业务"
                    }
                ],
                "relSpaces": null
            },
            {
                "messageTerminalId": "202103061220329542cdd3853dbae4d5bb86cca1ce565760e",
                "terminalType": "管家APP",
                "pushModes": [
                    "弹框",
                    "消息日志",
                    "toast",
                    "系统消息"
                ],
                "relGroups": [
                    {
                        "groupId": 27476,
                        "groupName": "云景消防队",
                        "orgId": 26211,
                        "orgName": "云景业务"
                    }
                ],
                "relSpaces": null
            },
            {
                "messageTerminalId": "20210306122032954373fa51b17b640c1aac5a29ce7b0b190",
                "terminalType": "社区APP",
                "pushModes": [
                    "弹框",
                    "消息日志",
                    "toast",
                    "系统消息"
                ],
                "relGroups": null,
                "relSpaces": [
                    {
                        "customerSelectMode": 1,
                        "projectId": null,
                        "projectName": null,
                        "spaceId": 23646,
                        "spaceType": "COMMUNITY",
                        "fullSpaceName": "美的置业广场体验馆",
                        "assambleName": "美的置业广场体验馆"
                    },
                    {
                        "customerSelectMode": 2,
                        "projectId": 23646,
                        "projectName": "美的置业广场体验馆",
                        "spaceId": 23665,
                        "spaceType": "HOUSE",
                        "fullSpaceName": "美的置业广场体验馆/建筑物/美的置业大楼/1单元/19/样板房",
                        "assambleName": "美的置业广场体验馆/建筑物/美的置业大楼/1单元/19/样板房"
                    }
                ]
            }
        ],
        "pageNo": null,
        "pageSize": null
    }
}

2.3 根据消息实例id,查询消息实例详情(其实就是根据id,查消息实例)

URL：/v1/scene/messageConfig/findMessageConfigById

方法：POST

请求参数

名称	位置	类型	必填	描述
id	body	String	y	主键id

请求Body描述(非Form表单数据)

{
    "id": "604303117c7e1130f4f523d8"
}

返回信息

返回参数类型

JSON

返回参数

返回示例：

{
    "code": "200",
    "message": "成功",
    "version": null,
    "result": {
        "createTime": null,
        "updateTime": null,
        "createBy": null,
        "updateBy": null,
        "id": "604303117c7e1130f4f523d8",
        "topBusinessOrgId": 21897,
        "authBusinessOrgId": 21897,
        "messageTemplateInfoType": "非事件消息",
        "messageConfigName": "测试系统繁忙事件消息20-实例1-修改1",
        "messageTemplateInfoId": "603258bfbd53814828830895",
        "enable": null,
        "messageTerminalDtos": [
            {
                "messageTerminalId": "20210306122032953fb013219659c45e1a5c4fda4d741defb",
                "terminalType": "IOC",
                "pushModes": [
                    "弹框",
                    "消息日志"
                ],
                "relGroups": [
                    {
                        "groupId": 27478,
                        "groupName": "云景清洁队11",
                        "orgId": 26211,
                        "orgName": "云景业务"
                    }
                ],
                "relSpaces": null
            },
            {
                "messageTerminalId": "20210306122032954f5fcf5b5153c446e8d5eee2522d49687",
                "terminalType": "后台",
                "pushModes": [
                    "弹框",
                    "消息日志",
                    "toast"
                ],
                "relGroups": [
                    {
                        "groupId": 27476,
                        "groupName": "云景消防队",
                        "orgId": 26211,
                        "orgName": "云景业务"
                    }
                ],
                "relSpaces": null
            },
            {
                "messageTerminalId": "202103061220329542cdd3853dbae4d5bb86cca1ce565760e",
                "terminalType": "管家APP",
                "pushModes": [
                    "弹框",
                    "消息日志",
                    "toast",
                    "系统消息"
                ],
                "relGroups": [
                    {
                        "groupId": 27476,
                        "groupName": "云景消防队",
                        "orgId": 26211,
                        "orgName": "云景业务"
                    }
                ],
                "relSpaces": null
            },
            {
                "messageTerminalId": "20210306122032954373fa51b17b640c1aac5a29ce7b0b190",
                "terminalType": "社区APP",
                "pushModes": [
                    "弹框",
                    "消息日志",
                    "toast",
                    "系统消息"
                ],
                "relGroups": null,
                "relSpaces": [
                    {
                        "customerSelectMode": 1,
                        "projectId": null,
                        "projectName": null,
                        "spaceId": 23646,
                        "spaceType": "COMMUNITY",
                        "fullSpaceName": "美的置业广场体验馆",
                        "assambleName": "美的置业广场体验馆"
                    },
                    {
                        "customerSelectMode": 2,
                        "projectId": 23646,
                        "projectName": "美的置业广场体验馆",
                        "spaceId": 23665,
                        "spaceType": "HOUSE",
                        "fullSpaceName": "美的置业广场体验馆/建筑物/美的置业大楼/1单元/19/样板房",
                        "assambleName": "美的置业广场体验馆/建筑物/美的置业大楼/1单元/19/样板房"
                    }
                ]
            }
        ],
        "pageNo": null,
        "pageSize": null
    }
}

2.4查询所有消息实例--下拉款--新增场景中使用(不支持分页)

URL：/v1/scene/messageConfig/findAllMessageConfigs

方法：POST

请求参数

名称	位置	类型	必填	描述
authBusinessOrgId	body	Long	y	页面左上角用于数据控制的业务组织id
messageTemplateInfoType	body	string	n	消息模板类型(事件消息及非事件消息)

请求Body描述(非Form表单数据)

{
    "authBusinessOrgId":21897
}

返回信息

返回参数类型

JSON

返回示例：

{
    "code": "200",
    "message": "成功",
    "version": null,
    "result": [
        {
            "createTime": null,
            "updateTime": null,
            "createBy": null,
            "updateBy": null,
            "id": "604303117c7e1130f4f523d8",
            "topBusinessOrgId": 21897,
            "authBusinessOrgId": 21897,
            "messageTemplateInfoType": "非事件消息",
            "messageConfigName": "测试系统繁忙事件消息20-实例1-修改1",
            "messageTemplateInfoId": "603258bfbd53814828830895",
            "enable": null,
            "messageTerminalDtos": [
                {
                    "messageTerminalId": "20210306122032953fb013219659c45e1a5c4fda4d741defb",
                    "terminalType": "IOC",
                    "pushModes": [
                        "弹框",
                        "消息日志"
                    ],
                    "relGroups": [
                        {
                            "groupId": 27478,
                            "groupName": "云景清洁队11",
                            "orgId": 26211,
                            "orgName": "云景业务"
                        }
                    ],
                    "relSpaces": null
                },
                {
                    "messageTerminalId": "20210306122032954f5fcf5b5153c446e8d5eee2522d49687",
                    "terminalType": "后台",
                    "pushModes": [
                        "弹框",
                        "消息日志",
                        "toast"
                    ],
                    "relGroups": [
                        {
                            "groupId": 27476,
                            "groupName": "云景消防队",
                            "orgId": 26211,
                            "orgName": "云景业务"
                        }
                    ],
                    "relSpaces": null
                },
                {
                    "messageTerminalId": "202103061220329542cdd3853dbae4d5bb86cca1ce565760e",
                    "terminalType": "管家APP",
                    "pushModes": [
                        "弹框",
                        "消息日志",
                        "toast",
                        "系统消息"
                    ],
                    "relGroups": [
                        {
                            "groupId": 27476,
                            "groupName": "云景消防队",
                            "orgId": 26211,
                            "orgName": "云景业务"
                        }
                    ],
                    "relSpaces": null
                },
                {
                    "messageTerminalId": "20210306122032954373fa51b17b640c1aac5a29ce7b0b190",
                    "terminalType": "社区APP",
                    "pushModes": [
                        "弹框",
                        "消息日志",
                        "toast",
                        "系统消息"
                    ],
                    "relGroups": null,
                    "relSpaces": [
                        {
                            "customerSelectMode": 1,
                            "projectId": null,
                            "projectName": null,
                            "spaceId": 23646,
                            "spaceType": "COMMUNITY",
                            "fullSpaceName": "美的置业广场体验馆",
                            "assambleName": "美的置业广场体验馆"
                        },
                        {
                            "customerSelectMode": 2,
                            "projectId": 23646,
                            "projectName": "美的置业广场体验馆",
                            "spaceId": 23665,
                            "spaceType": "HOUSE",
                            "fullSpaceName": "美的置业广场体验馆/建筑物/美的置业大楼/1单元/19/样板房",
                            "assambleName": "美的置业广场体验馆/建筑物/美的置业大楼/1单元/19/样板房"
                        }
                    ]
                }
            ],
            "pageNo": null,
            "pageSize": null
        }
    ]
}

2.5根据消息模板类型(精确查询)，消息实例名(全模糊查询)，查询所有消息实例(支持分页)

URL：/v1/scene/messageConfig/findAllMessageConfigByTypeOrLikeName

方法：POST

请求参数

名称	位置	类型	必填	描述
pageNo	body	String	y	当前页码
pageSize	body	String	y	页面大小
messageTemplateInfoType	body	String	y	消息模板类型(事件消息及非事件消息)
messageConfigName	body	String	n	消息实例名称
authBusinessOrgId	body	Long	y	页面左上角用于数据权限控制的业务组织

请求Body描述(非Form表单数据)

{
   "pageNo" : "1",
   "pageSize" : "2",
    "authBusinessOrgId":21897,
     "messageTemplateInfoType": "非事件消息",
     "messageConfigName": "事件"
}

返回信息

返回参数类型

JSON

返回示例：

{
    "code": "200",
    "message": "成功",
    "version": null,
    "result": [
        {
            "createTime": null,
            "updateTime": null,
            "createBy": null,
            "updateBy": null,
            "id": "604303117c7e1130f4f523d8",
            "topBusinessOrgId": 21897,
            "authBusinessOrgId": 21897,
            "messageTemplateInfoType": "非事件消息",
            "messageConfigName": "测试系统繁忙事件消息20-实例1-修改1",
            "messageTemplateInfoId": "603258bfbd53814828830895",
            "enable": null,
            "messageTerminalDtos": [
                {
                    "messageTerminalId": "20210306122032953fb013219659c45e1a5c4fda4d741defb",
                    "terminalType": "IOC",
                    "pushModes": [
                        "弹框",
                        "消息日志"
                    ],
                    "relGroups": [
                        {
                            "groupId": 27478,
                            "groupName": "云景清洁队11",
                            "orgId": 26211,
                            "orgName": "云景业务"
                        }
                    ],
                    "relSpaces": null
                },
                {
                    "messageTerminalId": "20210306122032954f5fcf5b5153c446e8d5eee2522d49687",
                    "terminalType": "后台",
                    "pushModes": [
                        "弹框",
                        "消息日志",
                        "toast"
                    ],
                    "relGroups": [
                        {
                            "groupId": 27476,
                            "groupName": "云景消防队",
                            "orgId": 26211,
                            "orgName": "云景业务"
                        }
                    ],
                    "relSpaces": null
                },
                {
                    "messageTerminalId": "202103061220329542cdd3853dbae4d5bb86cca1ce565760e",
                    "terminalType": "管家APP",
                    "pushModes": [
                        "弹框",
                        "消息日志",
                        "toast",
                        "系统消息"
                    ],
                    "relGroups": [
                        {
                            "groupId": 27476,
                            "groupName": "云景消防队",
                            "orgId": 26211,
                            "orgName": "云景业务"
                        }
                    ],
                    "relSpaces": null
                },
                {
                    "messageTerminalId": "20210306122032954373fa51b17b640c1aac5a29ce7b0b190",
                    "terminalType": "社区APP",
                    "pushModes": [
                        "弹框",
                        "消息日志",
                        "toast",
                        "系统消息"
                    ],
                    "relGroups": null,
                    "relSpaces": [
                        {
                            "customerSelectMode": 1,
                            "projectId": null,
                            "projectName": null,
                            "spaceId": 23646,
                            "spaceType": "COMMUNITY",
                            "fullSpaceName": "美的置业广场体验馆",
                            "assambleName": "美的置业广场体验馆"
                        },
                        {
                            "customerSelectMode": 2,
                            "projectId": 23646,
                            "projectName": "美的置业广场体验馆",
                            "spaceId": 23665,
                            "spaceType": "HOUSE",
                            "fullSpaceName": "美的置业广场体验馆/建筑物/美的置业大楼/1单元/19/样板房",
                            "assambleName": "美的置业广场体验馆/建筑物/美的置业大楼/1单元/19/样板房"
                        }
                    ]
                }
            ],
            "pageNo": null,
            "pageSize": null
        }
    ],
    "pageNo": 0,
    "pageSize": 0,
    "totalPage": 1,
    "total": 1
}

2.6 根据消息实例id,删除消息实例(如果删除失败,会返回引用该消息实例场景)

URL：/v1/scene/messageConfig/deleteMessageConfig

方法：POST

请求参数

名称	位置	类型	必填	描述
id	body	String	y	主键id

请求Body描述(非Form表单数据)

{
    "id": "60322ec5bd53814fb0674528"
}

返回参数类型

JSON

返回参数

名称	位置	类型	必填	描述
code	body	String	y	响应码
message	body	String	y	响应信息
result	body	String	n	返回数据

删除成功时返回的JSON
{
    "code": "200",
    "message": "成功",
    "result": null
}

删除失败时返回的JSON
{
    "code": "1",
    "message": "异常: 不允许删除,该消息实例,被以下场景引用",
    "result": null
}

3 运行结果—设备动作定义

3.1 运行结果—设备动作定义 -新增

URL： /v1/scene/deviceConfig/update

方法：POST

请求参数

名称	位置	类型	必填	描述
motionName	body	string	y	设备动作名称名
categoryPid	body	long	y	设备分类id
categoryId	body	long	y	设备类型id
deviceProductId	body	long	y	设备模板id
deviceProductName	body	string	y	设备模板名称
productServiceId	body	long	y	设备服务id
productServiceName	body	string	y	设备服务名称
serviceDescription	body	string	n	设备服务描述（前端不可编辑，设备服务有就传，没有就不传）
authOrgId	body	long	y	业务组织id（左上角指定的业务组织）
deviceConfigParamDtos	body	json集合	n	设备参数对象集合(设备服务有入参就传，没有入参就不传)
motionParamId	deviceConfigParamDtos	long	n	动作参数id
dataType	deviceConfigParamDtos	string	n	参数值的数据类型枚举值：double,long,string,boolean
serviceParamName	deviceConfigParamDtos	string	n	参数名
serviceParamValue	deviceConfigParamDtos	object	n	参数值（当dataType为boolean时，前端不应是文本框，而应该是单选器，传入后端true/false）

请求Body描述(非Form表单数据)

{
    "authOrgId": 21908,
    "motionName": "测试005",
    "categoryPid": 73,
    "categoryId": 75,
    "deviceProductId": "f67d2ef6b0df5b5e38a7c14e7dbe10e8",
    "deviceProductName": "模板test02a",
    "productServiceId": 15,
    "productServiceName": "deviceServiceName",
    "serviceDescription": "balabalabalaj",
    "deviceConfigParamDtos": [
                {
                    "serviceParamName": "paramName1",
                    "serviceParamValue": 10,
                    "dataType": "long",
                    "motionParamId": 56
                },
                {
                    "serviceParamName": "paramName2",
                    "serviceParamValue": 20,
                    "dataType": "long",
                    "motionParamId": 57
                }
            ]
}

返回信息

返回参数类型

JSON

返回示例：

{
    "code": "200",
    "message": "成功",
    "version": null,
    "result": {
        "createTime": null,
        "updateTime": null,
        "createBy": null,
        "updateBy": null,
        "id": "6034d4eb7c7e110db8744215",
        "topBusinessOrgId": 21897,
        "motionName": "测试005",
        "categoryPid": 73,
        "categoryId": 75,
        "deviceProductId": "f67d2ef6b0df5b5e38a7c14e7dbe10e8",
        "deviceProductName": "模板test02a",
        "productServiceId": 15,
        "productServiceName": "deviceServiceName",
        "serviceDescription": "balabalabalaj",
        "version": null,
        "enable": 1,
        "deviceConfigParamDtos": [
            {
                "createTime": null,
                "updateTime": null,
                "createBy": null,
                "updateBy": null,
                "serviceParamType": null,
                "serviceParamName": "paramName1",
                "serviceParamValue": 10,
                "dataType": "long",
                "motionParamId": 56,
                "version": null
            },
            {
                "createTime": null,
                "updateTime": null,
                "createBy": null,
                "updateBy": null,
                "serviceParamType": null,
                "serviceParamName": "paramName2",
                "serviceParamValue": 20,
                "dataType": "long",
                "motionParamId": 57,
                "version": null
            }
        ],
        "authOrgId": 21908,
        "ids": null,
        "pageNo": null,
        "pageSize": null
    }
}

3.2 运行结果—设备动作定义 -修改

URL： /v1/scene/deviceConfig/update

方法：POST

请求参数

名称	位置	类型	必填	描述
id	body	string	y	设备动作id
motionName	body	string	y	设备动作名称
productServiceId	body	long	y	设备服务id
deviceConfigParamDtos	body	json集合	n	设备参数对象集合(设备服务有入参就传，没有入参就不传)
motionParamId	deviceConfigParamDtos	long	n	动作参数id
dataType	deviceConfigParamDtos	string	n	参数值的数据类型枚举值：double,long,string,boolean
serviceParamName	deviceConfigParamDtos	string	n	参数名
serviceParamValue	deviceConfigParamDtos	object	n	参数值（当dataType为boolean时，前端不应是文本框，而应该是单选器，传入后端true/false）

请求Body描述(非Form表单数据)

{
    "id": "6034d4eb7c7e110db8744215",
    "authOrgId": 21908,
    "motionName": "测试005-修改",
    "productServiceId": 15,
    "deviceConfigParamDtos": [
                {
                    "serviceParamName": "paramName1",
                    "serviceParamValue": 10,
                    "dataType": "long",
                    "motionParamId": 56
                },
                {
                    "serviceParamName": "paramName2",
                    "serviceParamValue": 20,
                    "dataType": "long",
                    "motionParamId": 57
                }
            ]
}

返回信息

返回参数类型

JSON

返回示例：

{
    "code": "200",
    "message": "成功",
    "version": null,
    "result": {
        "createTime": null,
        "updateTime": null,
        "createBy": null,
        "updateBy": null,
        "id": "6034d4eb7c7e110db8744215",
        "topBusinessOrgId": 21897,
        "motionName": "测试005-修改",
        "categoryPid": 73,
        "categoryId": 75,
        "deviceProductId": "f67d2ef6b0df5b5e38a7c14e7dbe10e8",
        "deviceProductName": "模板test02a",
        "productServiceId": 15,
        "productServiceName": "deviceServiceName",
        "serviceDescription": "balabalabalaj",
        "version": null,
        "enable": 1,
        "deviceConfigParamDtos": [
            {
                "createTime": null,
                "updateTime": null,
                "createBy": null,
                "updateBy": null,
                "serviceParamType": null,
                "serviceParamName": "paramName1",
                "serviceParamValue": 10,
                "dataType": "long",
                "motionParamId": 56,
                "version": null
            },
            {
                "createTime": null,
                "updateTime": null,
                "createBy": null,
                "updateBy": null,
                "serviceParamType": null,
                "serviceParamName": "paramName2",
                "serviceParamValue": 20,
                "dataType": "long",
                "motionParamId": 57,
                "version": null
            }
        ],
        "authOrgId": null,
        "ids": null,
        "pageNo": null,
        "pageSize": null
    }
}

3.3运行结果—设备动作定义 -分页查询

URL： /v1/scene/deviceConfig/page

方法：POST

请求参数

名称	位置	类型	必填	描述
authOrgId	body	long	y	业务组织id（左上角指定的业务组织）
motionName	body	string	n	设备动作名称
pageNo	body	int	n	第几页（默认第一页）
pageSize	body	int	n	每页大小（默认10条）

请求Body描述(非Form表单数据)

{
    "authOrgId":21908,
    "motionName":"测试",
    "pageNo":1,
    "pageSize":1
}

返回信息

名称	位置	类型	描述
id	body	string	id
motionName	body	string	动作名称
deviceProductId	body	long	设备模板id
deviceProductName	body	string	设备模板名称
productServiceId	body	long	设备服务id
productServiceName	body	string	设备服务名称
serviceDescription	body	string	设备服务描述（前端不可编辑）
updateTime	body	date	最新修改时间

返回参数类型

JSON

返回示例：

{
    "code": "200",
    "message": "成功",
    "version": null,
    "result": [
        {
            "createTime": null,
            "updateTime": null,
            "createBy": null,
            "updateBy": null,
            "id": "60330e767c7e11145870bc08",
            "topBusinessOrgId": 10000,
            "motionName": "测试01",
            "categoryPid": 3,
            "categoryId": 7,
            "deviceProductId": "10001",
            "deviceProductName": "引擎模板",
            "productServiceId": 10002,
            "productServiceName": "引擎服务01",
            "serviceDescription": "这是用来测试的",
            "version": "1.0.01",
            "enable": 1,
            "deviceConfigParamDtos": [
                {
                    "createTime": null,
                    "updateTime": null,
                    "createBy": null,
                    "updateBy": null,
                    "serviceParamType": 1,
                    "serviceParamName": "启动1",
                    "serviceParamValue": "boot_now1",
                    "dataType": null,
                    "motionParamId": 10003,
                    "version": "1.0.01"
                },
                {
                    "createTime": null,
                    "updateTime": null,
                    "createBy": null,
                    "updateBy": null,
                    "serviceParamType": 1,
                    "serviceParamName": "启动2",
                    "serviceParamValue": "boot_now2",
                    "dataType": null,
                    "motionParamId": 10004,
                    "version": "1.0.01"
                }
            ],
            "authOrgId": null,
            "ids": null,
            "pageNo": null,
            "pageSize": null
        }
    ],
    "pageNo": 1,
    "pageSize": 1,
    "totalPage": 6,
    "total": 6
}

3.4运行结果—设备动作定义 -删除

URL： /v1/scene/deviceConfig/delete

方法：POST

请求参数

名称	位置	类型	必填	描述
id	body	long	y	设备动作id

请求Body描述(非Form表单数据)

{
    "id": "602fae45bd5381198cce11ab"
}

返回信息

返回参数类型

JSON

返回示例：

{
    "code": "200",
    "message": "成功",
    "version": null,
    "result": true
}

3.5运行结果—设备动作定义 -查看详情

URL： /v1/scene/deviceConfig/detail

方法：POST

请求参数

名称	位置	类型	必填	描述
id	body	long	y	设备动作id

请求Body描述(非Form表单数据)

{
    "id": "6034d4eb7c7e110db8744215"
}

返回信息

名称	位置	类型	描述
id	body	string	id
motionName	body	string	动作名称
categoryPid	body	long	设备分类id
categoryId	body	long	设备类型id
deviceProductId	body	long	设备模板id
deviceProductName	body	string	设备模板名称
productServiceId	body	long	设备服务id
productServiceName	body	string	设备服务名称
serviceDescription	body	string	设备服务描述（前端不可编辑）
deviceConfigParamDtos	body	json集合	设备参数对象集合
motionParamId	deviceConfigParamDtos	long	动作参数id
dataType	deviceConfigParamDtos	string	参数值的数据类型枚举值：double,long,string,boolean
serviceParamName	deviceConfigParamDtos	string	参数名
serviceParamValue	deviceConfigParamDtos	string	参数值（当dataType为boolean时，前端不应是文本框，而应该是单选器，传入后端“true”代表true；"false"代码false）

返回参数类型

JSON

返回示例：

{
    "code": "200",
    "message": "成功",
    "version": null,
    "result": {
        "createTime": null,
        "updateTime": null,
        "createBy": null,
        "updateBy": null,
        "id": "6034d4eb7c7e110db8744215",
        "topBusinessOrgId": 21897,
        "motionName": "测试005-修改",
        "categoryPid": 73,
        "categoryId": 75,
        "deviceProductId": "f67d2ef6b0df5b5e38a7c14e7dbe10e8",
        "deviceProductName": "模板test02a",
        "productServiceId": 15,
        "productServiceName": "deviceServiceName",
        "serviceDescription": "balabalabalaj",
        "version": null,
        "enable": 1,
        "deviceConfigParamDtos": [
            {
                "createTime": null,
                "updateTime": null,
                "createBy": null,
                "updateBy": null,
                "serviceParamType": null,
                "serviceParamName": "paramName1",
                "serviceParamValue": 10,
                "dataType": "long",
                "motionParamId": 56,
                "version": null
            },
            {
                "createTime": null,
                "updateTime": null,
                "createBy": null,
                "updateBy": null,
                "serviceParamType": null,
                "serviceParamName": "paramName2",
                "serviceParamValue": 20,
                "dataType": "long",
                "motionParamId": 57,
                "version": null
            }
        ],
        "authOrgId": null,
        "ids": null,
        "pageNo": null,
        "pageSize": null
    }
}

3.6 运行结果—设备动作定义 -下拉列表

URL： /v1/scene/deviceConfig/list

方法：POST

请求参数

名称	位置	类型	必填	描述
authOrgId	body	long	y	业务组织id（左上角指定的业务组织）
deviceProductId	body	long	y	设备模板id
authOrgId	body	long	y	业务组织id（左上角选择的业务组织）

请求Body描述(非Form表单数据)

{
     "authOrgId": 21908,
     "deviceProductId": "f67d2ef6b0df5b5e38a7c14e7dbe10e8"
}

返回信息

名称	位置	类型	描述
id	body	string	设备动作id
motionName	body	string	动作名称

返回参数类型

JSON

返回示例：

{
    "code": "200",
    "message": "成功",
    "version": null,
    "result": [
        {
            "createTime": null,
            "updateTime": null,
            "createBy": null,
            "updateBy": null,
            "id": "60349f007c7e1136a479a47c",
            "topBusinessOrgId": 21897,
            "motionName": "测试deviceServiceName",
            "categoryPid": 73,
            "categoryId": 75,
            "deviceProductId": "f67d2ef6b0df5b5e38a7c14e7dbe10e8",
            "deviceProductName": "模板test02a",
            "productServiceId": 15,
            "productServiceName": "deviceServiceName",
            "serviceDescription": "balabalabalaj",
            "version": null,
            "enable": 1,
            "deviceConfigParamDtos": [
                {
                    "createTime": null,
                    "updateTime": null,
                    "createBy": null,
                    "updateBy": null,
                    "serviceParamType": null,
                    "serviceParamName": "paramName1",
                    "serviceParamValue": 10,
                    "dataType": "long",
                    "motionParamId": 56,
                    "version": null
                },
                {
                    "createTime": null,
                    "updateTime": null,
                    "createBy": null,
                    "updateBy": null,
                    "serviceParamType": null,
                    "serviceParamName": "paramName2",
                    "serviceParamValue": 20,
                    "dataType": "long",
                    "motionParamId": 57,
                    "version": null
                }
            ],
            "authOrgId": null,
            "ids": null,
            "pageNo": null,
            "pageSize": null
        }
        ...

    ]
}

#

4. 场景定义

4.1: 新增场景

URL： /v1/scene/sceneTable/add

方法：POST

请求参数

名称	位置	类型	必填	描述
projectId	body	int	y	项目id
multiConditionMeetType	body	int	n	多个条件关系类型：多条件与(1)，多条件或(2)，暂不支持该功能，默认值为0
type	body	int	y	场景类型：事件场景(1)，定时场景(2)，手动场景(3)
sceneTemplateId	body	string	n	场景模板id(预留)
name	body	string	y	场景名称
eventCondition	body	Array	y	事件条件数组，暂仅支持一个条件
devTemplateId	eventCondition	string	n	设备模板id，事件场景必填项
devTemplateName	eventCondition	string	n	设备模板名称，事件场景必填项
eventRuleId	eventCondition	int	n	事件规则id，事件场景必填项
eventRuleName	eventCondition	string	n	事件规则名称，事件场景必填项
sceneResult	body	Array	n	场景结果数组
resultType	sceneResult	int	y	结果类别：设备动作1，工单2，消息3，场景4
devices	sceneResult	Array	y	resultType为设备动作时的从属设备数组
devId	devices	string	n	设备id，resultType为设备动作时必填项
devName	devices	string	n	设备名称，resultType为设备动作时必填项
devTemplateId	sceneResult	string	n	设备模板id，resultType为设备动作时必填项
devTemplateName	sceneResult	string	n	设备模板名称，resultType为设备动作时必填项
defineResultIdRelDtos	sceneResult	array	y	设备动作执行数组
defineResultIdRel	defineResultIdRelDtos	string	y	结果定义id，和结果类型resultType相对应
defineResultName	defineResultIdRelDtos	string	y	结果定义名称
delayExecTime	defineResultIdRelDtos	string	n	延迟执行时间，resultType为设备动作时必填项（eg：09:15:00）
cycleType	body	int	y	重复周期类型：每天(1)、每周(2)、每月(3)、指定日期区间(4)
startDate	body	string	n	重复周期类型值为4时，必填（eg：2021-02-20）
endDate	body	string	n	重复周期类型值为4时，必填（eg：2021-02-28）
startTime	body	string	y	开始时间(eg: 08:00)
endTime	body	string	y	结束时间(eg: 10:00)
timings	body	string	n	type取值2时必填项，定时场景的时间点集合，多个时间点用逗号分割(eg：08:00，10:00)
weeklyData	body	string	n	cycleType为每周(2)时，该字段必填，多个元素用逗号分割，(eg：1，2，3，4，5，6，0)
monthlyData	body	string	n	cycleType为每月(3)时，该字段赋值，元素取值范围(1~31)，多个元素用逗号分割(eg：1，3，5，6，7，31)
cronRegex	body	string	n	type为定时场景(3)进行赋值

请求Body描述(非Form表单数据)

{
    "id": "主键id",
    "projectId": 23414,
    "multiConditionMeetType": 0,
    "type": 1,
    "name": "场景01",
    "eventCondition": [{
            "devTemplateId": "",
            "devTemplateName": "",
            "eventRuleId": 8916,
            "eventRuleName": ""
        }],
    "sceneResult": [{
            "resultType": 1,
            "devTemplateId": "",
            "devTemplateName": "",
            "defineResultIdRelDtos": [{
                    "defineResultIdRel": "",
                    "defineResultName": "",
                    "delayExecTime": "09:15:00"
                }],
            "devices": [{
                    "devId": "",
                    "devName": ""
                }]
        }],
    "cycleType": 2,
    "startTime": "08:00",
    "endTime": "10:00",
    "weeklyData": "1,2,3,4,5,6,0"
}

返回信息

返回参数类型

JSON

返回参数

字段	位置	字段类型	是否必填	说明
code	顶层	string	y	响应码标识
message	顶层	string	y	响应消息文本
result	顶层	JSONObject	y	响应数据对象

返回示例：

{
    "code": "200",
    "message": "成功",
    "result": {}
}

4.2: 获取场景详情

URL： /v1/scene/sceneTable/detail

方法：POST

请求参数

名称	位置	类型	必填	描述
id	body	string	y	主键id

请求Body描述(非Form表单数据)

{
    "id": ""
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	说明
code	顶层	string	y	响应码标识
message	顶层	string	y	响应消息文本
result	顶层	JSONObject	y	响应数据对象
id	result	string	y	主键id
projectId	result	int	y	项目id
multiConditionMeetType	result	int	n	多个条件关系类型：多条件与(1)，多条件或(2)，暂不支持该功能，默认值为0
status	result	int	n	启用状态：1(启用)、2(停用)，默认取值1
type	result	int	y	场景类型：事件场景(1)，定时场景(2)，手动场景(3)
sceneTemplateId	result	string	n	场景模板id(预留)
name	result	string	y	场景名称
eventCondition	result	Array	y	事件条件数组，暂仅支持一个条件
devTemplateId	eventCondition	string	n	设备模板id，事件场景必填项
devTemplateName	eventCondition	string	n	设备模板名称，事件场景必填项
eventRuleId	eventCondition	int	n	事件规则id，事件场景必填项
eventRuleName	eventCondition	string	n	事件规则名称，事件场景必填项
sceneResult	result	Array	n	场景结果数组
resultType	sceneResult	int	y	结果类别：设备动作1，工单2，消息3，场景4
devices	sceneResult	Array	y	resultType为设备动作时的从属设备数组
devId	devices	string	n	设备id，resultType为设备动作时必填项
devName	devices	string	n	设备名称，resultType为设备动作时必填项
devTemplateId	sceneResult	string	n	设备模板id，resultType为设备动作时必填项
devTemplateName	sceneResult	string	n	设备模板名称，resultType为设备动作时必填项
defineResultIdRelDtos	sceneResult	array	y	设备动作执行数组
defineResultIdRel	defineResultIdRelDtos	string	y	结果定义id，和结果类型resultType相对应
defineResultName	defineResultIdRelDtos	string	y	结果定义名称
delayExecTime	defineResultIdRelDtos	string	n	延迟执行时间，resultType为设备动作时必填项（eg：09:15:00）
cycleType	result	int	y	重复周期类型：每天(1)、每周(2)、每月(3)、指定日期区间(4)
startDate	result	string	n	重复周期类型值为4时，必填（eg：2021-02-20）
endDate	result	string	n	重复周期类型值为4时，必填（eg：2021-02-28）
startTime	result	string	y	开始时间(eg: 08:00)
endTime	result	string	y	结束时间(eg: 10:00)
timings	result	string	n	type取值2时必填项，定时场景的时间点集合，多个时间点用逗号分割(eg：08:00，10:00)
weeklyData	result	string	n	cycleType为每周(2)时，该字段必填，多个元素用逗号分割，(eg："1，2，3，4，5，6，0")
monthlyData	result	string	n	cycleType为每月(3)时，该字段赋值，元素取值范围(1~31)，多个元素用逗号分割(eg："1，3，5，6，7，31")
cronRegex	result	string	n	type为定时场景(3)进行赋值

返回示例：

{
    "code": "200",
    "message": "成功",
    "result": {
            "id": "",
            "projectId": 23414,
            "multiConditionMeetType": 0，
            "status": 1,
                "type": 1,
                "name": "场景01",
            "eventCondition": [{
                "devTemplateId": "",
                "devTemplateName": "",
                "eventRuleId": "",
                "eventRuleName": "",
            }],
            "sceneResult": [{
                "resultType": 1,
                "devTemplateId": "",
                "devTemplateName": "",
                "devices": [{
                    "devId": "",
                    "devName": ""
                    }],
                "defineResultIdRelDtos": [{
                    "defineResultIdRel": "",
                    "defineResultName": "",
                    "delayExecTime": "09:15:00"
                }]    
            }]，
            "cycleType": 2,
            "startTime": "08:00",
            "endTime": "10:00",
            "weeklyData": "1,2,3,4,5,6,0"
        }
}

#

4.3: 场景编辑

URL： /v1/scene/sceneTable/update

方法：POST

请求参数

名称	位置	类型	必填	描述
id	body	类型	y	主键id
projectId	body	int	y	项目id
multiConditionMeetType	body	int	n	多个条件关系类型：多条件与(1)，多条件或(2)，暂不支持该功能，默认值为0
type	body	int	y	场景类型：事件场景(1)，定时场景(2)，手动场景(3)
sceneTemplateId	body	string	n	场景模板id(预留)
name	body	string	y	场景名称
eventCondition	body	Array	y	事件条件数组，暂仅支持一个条件
devTemplateId	eventCondition	string	n	设备模板id，事件场景必填项
devTemplateName	eventCondition	string	n	设备模板名称，事件场景必填项
eventRuleId	eventCondition	int	n	事件规则id，事件场景必填项
eventRuleName	eventCondition	string	n	事件规则名称，事件场景必填项
sceneResult	body	Array	n	场景结果数组
resultType	sceneResult	int	y	结果类别：设备动作1，工单2，消息3，场景4
devices	sceneResult	Array	y	resultType为设备动作时的从属设备数组
devId	devices	string	n	设备id，resultType为设备动作时必填项
devName	devices	string	n	设备名称，resultType为设备动作时必填项
devTemplateId	sceneResult	string	n	设备模板id，resultType为设备动作时必填项
devTemplateName	sceneResult	string	n	设备模板名称，resultType为设备动作时必填项
defineResultIdRelDtos	sceneResult	array	y	设备动作执行数组
defineResultIdRel	defineResultIdRelDtos	string	y	结果定义id，和结果类型resultType相对应
defineResultName	defineResultIdRelDtos	string	y	结果定义名称
delayExecTime	defineResultIdRelDtos	string	n	延迟执行时间，resultType为设备动作时必填项（eg：09:15:00）
cycleType	body	int	y	重复周期类型：每天(1)、每周(2)、每月(3)、指定日期区间(4)
startDate	body	string	n	重复周期类型值为4时，必填（eg：2021-02-20）
endDate	body	string	n	重复周期类型值为4时，必填（eg：2021-02-28）
startTime	body	string	y	开始时间(eg: 08:00)
endTime	body	string	y	结束时间(eg: 10:00)
timings	body	string	n	type取值2时必填项，定时场景的时间点集合，多个时间点用逗号分割(eg：08:00，10:00)
weeklyData	body	string	n	cycleType为每周(2)时，该字段必填，多个元素用逗号分割，(eg：1，2，3，4，5，6，0)
monthlyData	body	string	n	cycleType为每月(3)时，该字段赋值，元素取值范围(1~31)，多个元素用逗号分割(eg：1，3，5，6，7，31)
cronRegex	body	string	n	type为定时场景(3)进行赋值

请求Body描述(非Form表单数据)

{
    "id": "",
    "projectId": 23414,
    "multiConditionMeetType": 0,
    "type": 1,
    "name": "场景01",
    "eventCondition": {
            "devTemplateId": "",
            "devTemplateName": "",
            "eventRuleId": 2361,
            "eventRuleName": ""
        },
    "sceneResult": [{
                    "resultType": 1,
                    "devTemplateId": "",
                    "devTemplateName": "",
                    "devices": [{
                        "devId": "",
                        "devName": ""
                        }],
                    "defineResultIdRelDtos": [{
                        "defineResultIdRel": "",
                        "defineResultName": "",
                        "delayExecTime": "09:15:00"
                    }]    
                }],
    "cycleType": 2,
    "startTime": "08:00",
    "endTime": "10:00",
    "weeklyData": "1,2,3,4,5,6,0"
}

返回信息

返回参数类型

JSON

返回参数

字段	位置	字段类型	是否必填	说明
code	顶层	string	y	响应码标识
message	顶层	string	y	响应消息文本
result	顶层	JSONObject	y	响应数据对象

返回示例：

{
    "code": "200",
    "message": "成功",
    "result": {}
}

4.4: 场景分页

URL： /v1/scene/sceneTable/page

方法：POST

请求参数

名称	位置	必填	类型	描述
projectId	body	y	int	项目id
status	body	n	int	启用状态：1(启用)、2(停用)
name	body	n	string	场景名称，模糊搜索
pageNo	body	n	int	页码，默认1
pageSize	body	n	int	每页条数，默认10

请求Body描述(非Form表单数据)

{
    "projectId": 23414,
    "status": 2,
    "name": "",
    "pageNo": 2,
    "pageSize": 10
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	说明
code	顶层	string	y	响应码标识
message	顶层	string	y	响应消息文本
total	顶层	int	y	数据总量
totalPage	顶层	int	n	总页数
result	顶层	Array	y	响应数据对象
id	result	string	y	主键id
projectId	result	int	y	项目id
multiConditionMeetType	result	int	n	多个条件关系类型：多条件与(1)，多条件或(2)，暂不支持该功能，默认值为0
status	result	int	n	启用状态：1(启用)、2(停用)，默认取值1
type	result	int	y	场景类型：事件场景(1)，定时场景(2)，手动场景(3)
sceneTemplateId	result	string	n	场景模板id(预留)
name	result	string	y	场景名称
eventCondition	result	Array	y	事件条件数组，暂仅支持一个条件
devTemplateId	eventCondition	string	n	设备模板id，事件场景必填项
devTemplateName	eventCondition	string	n	设备模板名称，事件场景必填项
eventRuleId	eventCondition	int	n	事件规则id，事件场景必填项
eventRuleName	eventCondition	string	n	事件规则名称，事件场景必填项
sceneResult	result	Array	n	场景结果数组
resultType	sceneResult	int	y	结果类别：设备动作1，工单2，消息3，场景4
devices	sceneResult	Array	y	resultType为设备动作时的从属设备数组
devId	devices	string	n	设备id，resultType为设备动作时必填项
devName	devices	string	n	设备名称，resultType为设备动作时必填项
devTemplateId	sceneResult	string	n	设备模板id，resultType为设备动作时必填项
devTemplateName	sceneResult	string	n	设备模板名称，resultType为设备动作时必填项
defineResultIdRel	sceneResult	string	y	结果定义id，和结果类型resultType相对应
defineResultName	sceneResult	string	y	结果定义名称
delayExecTime	sceneResult	string	n	延迟执行时间，resultType为设备动作时必填项（eg：09:15:00）
cycleType	result	int	y	重复周期类型：每天(1)、每周(2)、每月(3)、指定日期区间(4)
startDate	result	string	n	重复周期类型值为4时，必填（eg：2021-02-20）
endDate	result	string	n	重复周期类型值为4时，必填（eg：2021-02-28）
startTime	result	string	y	开始时间(eg: 08:00)
endTime	result	string	y	结束时间(eg: 10:00)
timings	result	string	n	type取值2时必填项，定时场景的时间点集合，多个时间点用逗号分割(eg：08:00，10:00)
weeklyData	result	string	n	cycleType为每周(2)时，该字段必填，多个元素用逗号分割，(eg：1，2，3，4，5，6，0)
monthlyData	result	string	n	cycleType为每月(3)时，该字段赋值，元素取值范围(1~31)，多个元素用逗号分割(eg：1，3，5，6，7，31)
cronRegex	result	string	n	type为定时场景(3)进行赋值

返回示例：

{
    "code": "200",
    "message": "成功",
    "result": [
        {
            "id": "",
            "projectId": 23414,
            "multiConditionMeetType": 0，
            "status": 1,
                "type": 1,
                "name": "场景01",
            "eventCondition": {
                "devTemplateId": "",
                "devTemplateName": "",
                "eventRuleId": 2389,
                "eventRuleName": "",
            },
            "sceneResult": {
                "resultType": 1,
                "devTemplateId": "",
                "devTemplateName": "",
                "defineResultIdRel": "",
                "defineResultName": "",
                "delayExecTime": "09:15:00"
            },
            "cycleType": 2,
            "startTime": "08:00",
            "endTime": "10:00",
            "weeklyData": "1,2,3,4,5,6,0"
        }
    ],
    "total": 53,
    "totalPage": 6
}

4.5: 场景删除

URL： /v1/scene/sceneTable/remove

方法：POST

请求参数

名称	位置	类型	必填	描述
id	body	string	y	主键id

请求Body描述(非Form表单数据)

{
    "id": ""
}

返回信息

返回参数类型

JSON

返回参数

字段	位置	字段类型	是否必填	说明
code	顶层	string	y	响应码标识
message	顶层	string	y	响应消息文本
result	顶层	JSONObject	y	响应数据对象

返回示例：

{
    "code": "200",
    "message": "成功",
    "result": {}
}

#

4.6: 场景状态控制

URL： /v1/scene/sceneTable/bootStatus

方法：POST

请求参数

名称	位置	类型	必填	描述
id	body	string	y	主键id
status	body	int	y	启用状态：1(启用)、2(停用)

请求Body描述(非Form表单数据)

{
    "id": "",
    "status": 2
}

返回信息

返回参数类型

JSON

返回参数

字段	位置	字段类型	是否必填	说明
code	顶层	string	y	响应码标识
message	顶层	string	y	响应消息文本
result	顶层	JSONObject	y	响应数据对象

返回示例：

{
    "code": "200",
    "message": "成功",
    "result": {}
}

#

4.7: 手动场景下拉框列表

URL： /v1/scene/sceneTable/manualSceneList

描述：仅支持选择手动场景，不能选择已嵌套其它场景的场景

方法：POST

请求参数

名称	位置	类型	必填	描述
projectId	body	int	y	项目id

请求Body描述(非Form表单数据)

{
    "projectId": 23414
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	说明
code	顶层	string	y	响应码标识
message	顶层	string	y	响应消息文本
total	顶层	int	y	数据总量
result	顶层	Array	y	响应数据对象
id	result	string	y	主键id
projectId	result	int	y	项目id
status	result	int	n	启用状态：1(启用)、2(停用)，默认取值1
type	result	int	y	场景类型：手动场景(3)
sceneTemplateId	result	string	n	场景模板id(预留)
name	result	string	y	场景名称
sceneResult	result	Array	n	场景结果数组
resultType	sceneResult	int	y	结果类别：设备动作1，工单2，消息3，场景4
devices	sceneResult	Array	y	resultType为设备动作时的从属设备数组
devId	devices	string	n	设备id，resultType为设备动作时必填项
devName	devices	string	n	设备名称，resultType为设备动作时必填项
devTemplateId	sceneResult	string	n	设备模板id，resultType为设备动作时必填项
devTemplateName	sceneResult	string	n	设备模板名称，resultType为设备动作时必填项
defineResultIdRel	sceneResult	string	y	结果定义id，和结果类型resultType相对应
defineResultName	sceneResult	string	y	结果定义名称
delayExecTime	sceneResult	string	n	延迟执行时间，resultType为设备动作时必填项（eg：09:15:00）

返回示例：

{
    "code": "200",
    "message": "成功",
    "result": [
        {
            "id": "",
            "projectId": 23414,
            "status": 1,
                "type": 3,
                "name": "手动场景01",
            "sceneResult": [
                {
                    "resultType": 1,
                    "devTemplateId": "",
                    "devTemplateName": "",
                    "defineResultIdRel": "",
                    "defineResultName": "",
                    "delayExecTime": "09:15:00"
                }
            ]
        }
    ],
    "total": 16
}

#

4.8: 场景列表

URL： /v1/scene/sceneTable/list

描述：根据项目id查询场景list

方法：POST

请求参数

名称	位置	类型	必填	描述
projectId	body	int	n	项目id

请求Body描述(非Form表单数据)

{
    "projectId": 23414
}

返回信息

返回参数类型

JSON

返回参数

名称	位置	类型	必填	说明
code	顶层	string	y	响应码标识
message	顶层	string	y	响应消息文本
total	顶层	int	y	数据总量
result	顶层	Array	y	响应数据对象
id	result	string	y	主键id
projectId	result	int	y	项目id
status	result	int	n	启用状态：1(启用)、2(停用)，默认取值1
type	result	int	y	场景类型：手动场景(3)
sceneTemplateId	result	string	n	场景模板id(预留)
name	result	string	y	场景名称
sceneResult	result	Array	n	场景结果数组
resultType	sceneResult	int	y	结果类别：设备动作1，工单2，消息3，场景4
devices	sceneResult	Array	y	resultType为设备动作时的从属设备数组
devId	devices	string	n	设备id，resultType为设备动作时必填项
devName	devices	string	n	设备名称，resultType为设备动作时必填项
devTemplateId	sceneResult	string	n	设备模板id，resultType为设备动作时必填项
devTemplateName	sceneResult	string	n	设备模板名称，resultType为设备动作时必填项
defineResultIdRel	sceneResult	string	y	结果定义id，和结果类型resultType相对应
defineResultName	sceneResult	string	y	结果定义名称
delayExecTime	sceneResult	string	n	延迟执行时间，resultType为设备动作时必填项（eg：09:15:00）

返回示例：

{
    "code": "200",
    "message": "成功",
    "result": [
        {
            "id": "",
            "projectId": 23414,
            "status": 1,
                "type": 3,
                "name": "手动场景01",
            "sceneResult": [
                {
                    "resultType": 1,
                    "devTemplateId": "",
                    "devTemplateName": "",
                    "defineResultIdRel": "",
                    "defineResultName": "",
                    "delayExecTime": "09:15:00"
                }
            ]
        }
    ],
    "total": 16
}

#

5.1 事件中心 —列表分页查询

URL： /v1/scene/sceneEventCenter/page

方法：POST

请求参数

名称	位置	类型	必填	描述
projectId	body	long	y	项目id
eventClassifyId	body	long	n	事件分类
eventTypeId	body	long	n	事件类型
eventLevelId	body	long	n	事件等级
eventName	body	string	n	事件名称
triggerDeviceName	body	string	n	设备名称
sceneId	body	string	n	联动场景
processingStatus	body	int	n	处理状态 1:待处理, 2:处理中, 3:已处理
pageNo	body	int	n	第几页
pageSize	body	int	n	每页大小

请求Body描述(非Form表单数据)

{
    "projectId":123,
    "eventClassifyId":1,
    "eventTypeId":2,
    "eventLevelId":4,
    "eventName":"事件名称",
    "triggerDeviceName":"设备名称",
    "sceneId":"联动场景",
    "processingStatus":1,
    "pageNo":1,
    "pageSize":1
}

返回信息

名称	位置	类型	必填	描述
id	body	string	y	id
projectId	body	long	y	项目id
processingStatus	body	int	n	处理状态
eventLevel	body	string	n	事件等级
eventName	body	string	n	事件名称
triggerEventRuleName	body	string	n	触发规则
triggerConditionName	body	string	n	触发条件
triggerDeviceName	body	string	n	触发设备
triggerDate	body	date	n	触发时间
eventDesc	body	string	n	事件描述
sceneName	body	string	n	联动场景
handlerName	body	string	n	处理人
handlerDesc	body	string	n	处理人描述
handlerDate	body	date	n	处理人时间
handlerDesc	body	string	n	处理人描述
handlerDate	body	date	n	处理人时间
actionDate	body	date	n	执行时间
actionStatus	body	string	n	执行状态

返回参数类型

JSON

返回示例：

{
    "code": "200",
    "message": "成功",
    "result": [
        {
            "id":"123456789",
            "projectId":3,
            "processingStatus":3,
            "eventLevel":"动作名称",
            "eventName":"事件名称",
            "triggerEventRuleName":"触发规则",
            "triggerConditionName":"触发条件",
            "triggerDeviceName":"触发设备",
            "triggerDate":"触发时间",
            "eventDesc":"事件描述",
            "sceneName":"联动场景",
            "handlerName":"处理人",
            "handlerDesc":"处理人描述",
            "handlerDate":"处理人时间",
            "actionDate":"执行时间",
            "actionStatus":"执行状态"
        }
    ],
    "pageNo": 1,
    "pageSize": 10,
    "total": 10,
    "totalPage": 1
}

5.2 事件中心 —联动设备-列表分页查询

URL： /v1/scene/sceneDeviceResult/page

方法：POST

请求参数

名称	位置	类型	必填	描述
eventCenterId	body	string	y	事件中心id
deviceName	body	string	n	设备名称
mac	body	string	n	设备mac地址
pageNo	body	int	n	第几页
pageSize	body	int	n	每页大小

请求Body描述(非Form表单数据)

{
    "eventCenterId":"123",
    "deviceName":"设备名称",
    "mac":"设备mac地址",
    "pageNo":1,
    "pageSize":1
}

返回信息

名称	位置	类型	必填	描述
id	body	string	y	id
eventCenterId	body	string	n	事件中心id
deviceProductName	body	string	n	设备模板名称
deviceName	body	string	n	设备名称
mac	body	string	n	设备mac地址
actionContent	body	string	n	执行内容
actionResult	body	string	n	执行结果
actionDate	body	date	n	执行时间

返回参数类型

JSON 返回示例：

{
    "code": "200",
    "message": "成功",
    "result": [
        {
            "id":"123456789",
            "eventCenterId":"123456789",
            "deviceProductName":"设备模板名称",
            "deviceName":"设备名称",
            "mac":"设备mac地址",
            "actionContent":"执行内容",
            "actionResult":"执行结果",
            "actionDate":"执行时间"
        }
    ],
    "pageNo": 1,
    "pageSize": 10,
    "total": 10,
    "totalPage": 1
}

5.3 事件中心 —联动转发工单-列表分页查询

URL： /v1/scene/sceneWorkOrderResult/page

方法：POST

请求参数

名称	位置	类型	必填	描述
eventCenterId	body	string	y	事件中心id
pageNo	body	int	n	第几页
pageSize	body	int	n	每页大小

请求Body描述(非Form表单数据)

{
    "eventCenterId":"123",
    "pageNo":1,
    "pageSize":1
}

返回信息

名称	位置	类型	必填	描述
id	body	string	y	id
eventCenterId	body	string	n	事件中心id
orderName	body	string	n	工单名称
orderTemplateName	body	string	n	工单模板名称
sceneName	body	string	n	联动场景
orderDesc	body	string	n	工单描述
orderStatus	body	string	n	工单状态 1:待处理, 2:处理中, 3:已处理
handlerName	body	string	n	处理人姓名
updateDate	body	date	n	更新时间

返回参数类型

JSON

返回示例：

{
    "code": "200",
    "message": "成功",
    "result": [
        {
            "id":"123456789",
            "eventCenterId":"123456789",
            "orderName":"工单名称",
            "orderTemplateName":"工单模板名称",
            "sceneName":"联动场景"
            "orderDesc":"工单描述",
            "orderStatus":"工单状态",
            "handlerName":"处理人姓名",
            "updateDate":"更新时间"           
        }
    ],
    "pageNo": 1,
    "pageSize": 10,
    "total": 10,
    "totalPage": 1
}

5.4 事件中心 —推送消息-列表分页查询

URL： /v1/scene/scenePushMessageResult/page

方法：POST

请求参数

名称	位置	类型	必填	描述
eventCenterId	body	string	y	事件中心id
pageNo	body	int	n	第几页
pageSize	body	int	n	每页大小

请求Body描述(非Form表单数据)

{
    "eventCenterId":"123",
    "pageNo":1,
    "pageSize":1
}

返回信息

名称	位置	类型	必填	描述
id	body	string	y	id
eventCenterId	body	string	n	事件中心id
messageTemplateName	body	string	n	推送模板名称
terminalType	body	string	n	终端类型
pushMode	body	string	n	推送形式
personName	body	string	n	推送对象
pushDate	body	date	n	推送时间
sceneName	body	string	n	场景名称
terminalType	body	string	n	终端类型
messageTemplateType	body	string	n	消息类型
messageTemplateTitle	body	string	n	消息标题
messageTemplateContent	body	string	n	消息内容
messageTemplateRedirectUrl	body	string	n	跳转连接
orgName	body	string	n	组织名称
userName	body	string	n	用户名称

返回参数类型

JSON

返回示例：

{
    "code": "200",
    "message": "成功",
    "result": [
        {
            "id":"123456789",
            "eventCenterId":"123456789",
            "messageTemplateName":"推送模板名称",
            "terminalType":"终端类型",
            "pushMode":"推送形式" ,
            "personName":"推送对象",
            "sceneName":"终端类型",    
            "terminalType":"推送时间",    
            "messageTemplateType":"消息类型",    
            "messageTemplateTitle":"消息标题",    
            "messageTemplateContent":"消息内容",    
            "messageTemplateRedirectUrl":"跳转连接",    
            "orgName":"组织名称",    
            "userName":"用户名称"
        }
    ],
    "pageNo": 1,
    "pageSize": 10,
    "total": 10,
    "totalPage": 1
}

5.5 事件中心 —嵌套场景-列表分页查询

URL： /v1/scene/sceneNestScenarioResult/page

方法：POST

请求参数

名称	位置	类型	必填	描述
eventCenterId	body	string	y	事件中心id
pageNo	body	int	n	第几页
pageSize	body	int	n	每页大小

请求Body描述(非Form表单数据)

{
    "eventCenterId":"123",
    "pageNo":1,
    "pageSize":1
}

返回信息

名称	位置	类型	必填	描述
id	body	string	y	id
eventCenterId	body	string	n	事件中心id
sceneName	body	string	n	执行场景
actionResult	body	string	n	执行结果
actionDate	body	date	n	执行时间

返回参数类型

JSON 返回示例：

{
    "code": "200",
    "message": "成功",
    "result": [
        {
            "id":"123456789",
            "eventCenterId":"123456789",
            "sceneName":"执行场景",
            "actionResult":"执行结果",             
            "actionDate":"执行时间"              
        }
    ],
    "pageNo": 1,
    "pageSize": 10,
    "total": 10,
    "totalPage": 1
}

5.6 事件中心 —事件批量处理

URL： /v1/scene/sceneEventCenter/handleBatch

方法：POST

请求参数

名称	位置	类型	必填	描述
eventCenterId	body	array	y	事件中心id
handlerDesc	body	String	y	处理描述

请求Body描述(非Form表单数据)

{
  "eventCenterId":["123","456","789"],
  "handlerDesc": "处理描述"
}

返回信息

名称	位置	类型	必填	描述
code	body	int	y	id
message	body	string	n	返回信息

返回参数类型

JSON 返回示例：

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

#

6. 场景日志

6.1: 场景日志分页

URL： /v1/scene/sceneExecLog/page

方法：POST

请求参数

名称	位置	类型	必填	描述
projectId	body	int	y	项目id
pageNo	body	n	int	页码，默认1
pageSize	body	n	int	每页条数，默认10
sceneName	body	n	string	场景日志名称，模糊查询

请求Body描述(非Form表单数据)

{
    "projectId": 23414,
    "sceneName": "",
    "pageNo": 2,
    "pageSize": 10
}

返回信息

返回参数类型

JSON

返回参数

字段	位置	字段类型	是否必填	说明
code	顶层	string	y	响应码标识
message	顶层	string	y	响应消息文本
result	顶层	Array	y	响应数据对象
id	result	string	n	场景日志主键id
projectId	result	int	n	项目id
sceneId	result	string	n	场景主键id
sceneName	result	string	n	场景名称
execTime	result	string	n	执行时间
execResult	result	int	n	执行结果：全部执行成功(1)、部分未执行(2)、未执行(3)
total	顶层	int	n	数据总数
totalPage	顶层	int	n	总页数

返回示例：

{
    "code": "200",
    "message": "成功",
    "version": null,
    "result": [
        {
            "id": "6047674a8a7ca4e83829522d",
            "eventCenterId": "604765628a7ca442d068a0e9",
            "sceneId": null,
            "sceneName": "场景中心",
            "execTime": null,
            "execResult": "执行结果"
        }
    ],
    "pageNo": 0,
    "pageSize": 0,
    "totalPage": 1,
    "total": 2
}

6.2: 联动设备分页

URL： /v1/scene/sceneExecDeviceResult/page

方法：POST

请求参数

名称	位置	类型	必填	描述
pageNo	body	n	int	页码，默认1
pageSize	body	n	int	每页条数，默认10
deviceName	body	string	n	设备名称
mac	body	string	n	设备mac地址

请求Body描述(非Form表单数据)

{
    "deviceName": "",
    "mac": "",
    "pageNo": 2,
    "pageSize": 10
}

返回信息

返回参数类型

JSON

返回参数

字段	位置	字段类型	是否必填	说明
code	顶层	string	y	响应码标识
message	顶层	string	y	响应消息文本
result	顶层	Array	y	响应数据对象
id	result	string	n	场景日志主键id
sceneId	result	string	n	场景主键id
sceneExecLogId	result	string	n	场景日志主键id
deviceProductId	result	string	n	设备模板id
deviceProductName	result	string	n	设备模板名称
mac	result	string	n	mac地址
actionContent	result	string	n	执行内容
actionResult	result	string	n	执行结果
actionDate	result	string	n	执行时间
total	顶层	int	n	数据总数
totalPage	顶层	int	n	总页数

返回示例：

{
    "code": "200",
    "message": "成功",
    "version": null,
    "result": [
        {
            "id": "604767dd8a7ca48174d2a65c",
            "logId": "6047674a8a7ca4e83829522d",
            "spaceId": 0,
            "spaceType": null,
            "sceneId": null,
            "sceneName": null,
            "deviceProductId": 0,
            "deviceProductName": null,
            "mac": null,
            "deviceId": null,
            "deviceName": "设备",
            "actionContent": "执行内容",
            "actionResult": null,
            "actionDate": null,
            "issueUuid": null,
            "issueInstruct": null,
            "issueDate": null,
            "version": null
        }
    ],
    "pageNo": 0,
    "pageSize": 0,
    "totalPage": 1,
    "total": 0
}

6.3: 推送消息分页

URL： /v1/scene/sceneExecDetailMessage/page

方法：POST

请求参数

名称	位置	类型	必填	描述
pageNo	body	n	int	页码，默认1
pageSize	body	n	int	每页条数，默认10

请求Body描述(非Form表单数据)

{
    "pageNo": 2,
    "pageSize": 10
}

返回信息

返回参数类型

JSON

返回参数

字段	位置	字段类型	是否必填	说明
code	顶层	string	y	响应码标识
message	顶层	string	y	响应消息文本
result	顶层	Array	y	响应数据对象
id	result	string	n	场景日志主键id
sceneId	result	string	n	场景主键id
sceneExecLogId	result	string	n	场景日志主键id
messageTemplateName	body	string	n	推送模板名称
terminalType	body	string	n	终端类型
pushMode	body	string	n	推送形式
personName	body	string	n	推送对象
pushDate	body	date	n	推送时间
total	顶层	int	n	数据总数
totalPage	顶层	int	n	总页数

返回示例：

{ "code": "200", "message": "成功", "version": null, "result": [ { "id": "604767d78a7ca463105ac127", "logId": "6047674a8a7ca4e83829522d", "projectId": null, "eventCenterId": "604765628a7ca442d068a0e9", "sceneId": null, "sceneName": "场景名称", "terminalId": null, "terminalType": null, "pushMode": null, "messageTemplateId": null, "messageTemplateName": null, "messageTemplateType": null, "messageTemplateTitle": "消息标题", "messageTemplateContent": "消息内容", "messageTemplateRedirectUrl": null, "orgId": null, "orgName": null, "personId": null, "personName": null, "userId": null, "userName": null, "pushDate": null } ], "pageNo": 0, "pageSize": 0, "totalPage": 1, "total": 0 }

6.4: 嵌套场景分页

URL： /v1/scene/sceneExecDetailNest/page

方法：POST

请求参数

名称	位置	类型	必填	描述
pageNo	body	n	int	页码，默认1
pageSize	body	n	int	每页条数，默认10

请求Body描述(非Form表单数据)

{
    "pageNo": 2,
    "pageSize": 10
}

返回信息

返回参数类型

JSON

返回参数

字段	位置	字段类型	是否必填	说明
code	顶层	string	y	响应码标识
message	顶层	string	y	响应消息文本
result	顶层	Array	y	响应数据对象
id	result	string	n	场景日志主键id
sceneId	result	string	n	场景主键id
sceneExecLogId	result	string	n	场景日志主键id
execSceneName	result	string	n	执行场景名称
actionResult	result	string	n	执行结果
actionDate	result	string	n	执行时间
total	顶层	int	n	数据总数
totalPage	顶层	int	n	总页数

返回示例：

{
    "code": "200",
    "message": "成功",
    "version": null,
    "result": [
        {
            "id": "604768378a7ca46d98aa94cf",
            "logId": "6047674a8a7ca4e83829522d",
            "projectId": null,
            "eventCenterId": "604765628a7ca442d068a0e9",
            "sceneId": null,
            "sceneName": "场景名称",
            "nestScenarioId": null,
            "nestScenarioName": "嵌套场景",
            "execDetailNestId": null
        }
    ],
    "pageNo": 0,
    "pageSize": 0,
    "totalPage": 1,
    "total": 0
}

7. 场景中心手动执行

7.1: 场景中心手动执行

URL： /v1/scene/sceneEventCenter/manual

方法：POST

请求参数

名称	位置	类型	必填	描述
id	body	int	y	场景中心id

请求Body描述(非Form表单数据)

{
    "id":"604325b05a7d016f490f02dc"
}

返回信息

返回参数类型

JSON

返回参数

字段	位置	字段类型	是否必填	说明
code	顶层	string	y	响应码标识
message	顶层	string	y	响应消息文本
result	顶层	Array	y	响应数据对象

返回示例：

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