条件集管理接口
创建条件集
- 接口intent:config.event.create
- 接口描述:本接口用于自定义设置触发条件(Conditions),支持多个“AND”和“OR”条件的组合触发。通过“query.ifttt.trigger”接口查询条件参数说明后,再通过本接口创建条件集。
- 请求参数
名称 |
类型 |
是否必须 |
描述 |
name |
String |
是 |
条件集名称 |
positionId |
String |
否 |
设备位置id,为空取默认位置 |
relation |
Integer |
是 |
0:与 1:或 默认为0 |
condition |
Array(Object) |
是 |
触发条件内容,详见condition说明 |
condition说明
名称 |
类型 |
是否必须 |
描述 |
subjectId |
string |
否 |
对象ID (如设备id、场景id) (与model至少必填一个) |
model |
String |
否 |
物模型 |
triggerDefinitionId |
String |
是 |
触发id |
beginTime |
String |
否 |
开始时段,格式说明如下 |
endTime |
String |
否 |
结束时段,格式说明如下 |
params |
Array(Object) |
否 |
参数,详见params说明 |
说明:定时/时段的格式:“分 时 天 月 周” ,对应参数“beginTime”和“endTime”。
- “分”:取值范围为 0 到 59,值 * 表示不限制分钟。
- “时”:取值范围为 0 到 23,值 * 表示不限制小时。
- “天”:取值范围为1-31,值 * 表示不限制天,任何天。
- “月”:取值范围从1到12, 值 * 表示无限制月份,任意月份。
- “周”:取值范围为0-8,0表示星期日,1-6表示周一至周六,7表示节假日,8表示工作日,值 * 表示无限制周。
例如:“10 11 * 1,2,3,4,5,6,0” 表示每天上午11:10。“20 18 \ * 1,4,6”表示每周一、四、六下午18:20。
params说明
名称 |
类型 |
是否必须 |
描述 |
paramId |
string |
否 |
参数id |
value |
String |
否 |
值 |
paramType |
String |
否 |
参数类型 |
paramUnit |
String |
否 |
参数单位 |
{
"intent": "config.event.create",
"data": {
"positionId":"real1.832621257077604352",
"name": "name1",
"relation": 0,
"condition": [
{
"subjectId": "virtual2.55793119265827",
"triggerDefinitionId": "TD.lumi.gateway.light_on"
},
{
"subjectId": "virtual2.55793119265827",
"triggerDefinitionId": "TD.lumi.gateway.illumination_more_than",
"params": [
{
"paramId": "PD.illumination",
"value": "20"
}
]
}
]
}
}
名称 |
类型 |
描述 |
eventId |
string |
条件集ID |
{
"code": 0,
"message": "Success",
"msgDetails": "",
"requestId": "",
"result": {
"eventId": "CL.842499037874565120"
}
}
更新条件集
- 接口intent:config.event.update
- 接口描述:本接口用于修改条件集的参数配置和名称。
- 请求参数
名称 |
类型 |
是否必须 |
描述 |
eventId |
String |
是 |
条件集ID |
name |
String |
是 |
条件集名称 |
positionId |
String |
否 |
设备位置id,为空取默认位置 |
relation |
Integer |
是 |
0:与 1:或 默认为0 |
condition |
Array(Object) |
是 |
触发条件内容,详见condition说明 |
enable |
Integer |
是 |
条件集是否启用,0-禁用,1-启用 |
condition说明
名称 |
类型 |
是否必须 |
描述 |
subjectId |
string |
否 |
对象ID (如设备id、场景id) (与model至少必填一个) |
model |
String |
否 |
物模型 |
triggerDefinitionId |
String |
是 |
触发id |
beginTime |
String |
否 |
开始时段 |
endTime |
String |
否 |
结束时段 |
params |
Array(Object) |
否 |
参数,详见params说明 |
params说明
名称 |
类型 |
是否必须 |
描述 |
paramId |
string |
否 |
参数id |
value |
String |
否 |
值 |
paramType |
String |
否 |
参数类型 |
paramUnit |
String |
否 |
参数单位 |
{
"intent": "config.event.update",
"data": {
"eventId": "CL.842499037874565120",
"enable":0,
"positionId":"real1.832621257077604352",
"name": "name1",
"relation": 0,
"condition": [
{
"subjectId": "virtual2.55793119265827",
"triggerDefinitionId": "TD.lumi.gateway.light_on"
},
{
"subjectId": "virtual2.55793119265827",
"triggerDefinitionId": "TD.lumi.gateway.illumination_more_than",
"params": [
{
"paramId": "PD.illumination",
"value": "20"
}
]
}
]
}
}
名称 |
类型 |
描述 |
eventId |
string |
条件集ID |
{
"code": 0,
"message": "Success",
"msgDetails": "",
"requestId": "",
"result": {
"eventId": "CL.842499037874565120"
}
}
删除条件集
- 接口intent:config.event.delete
- 接口描述:本接口用于删除条件集。
- 请求参数
名称 |
类型 |
是否必须 |
描述 |
eventId |
String |
是 |
条件集ID |
{
"intent": "config.event.delete",
"data": {
"eventId": "CL.842499037874565120"
}
}
{
"code": 0,
"message": "Success",
"msgDetails": "",
"requestId": "",
"result": ""
}
查询条件集详情
- 接口intent:query.event.detail
- 接口描述:本接口用于查询条件集的各条件配置详情。
- 请求参数
名称 |
类型 |
是否必须 |
描述 |
eventId |
String |
是 |
条件集id |
{
"intent": "query.event.detail",
"data": {
"eventId": "CL.842499037874565120"
}
}
名称 |
类型 |
描述 |
eventId |
string |
条件集ID |
name |
String |
条件集名称 |
enable |
int |
条件集是否启用,0: 禁用 1: 启用 |
triggerType |
int |
0-瞬态,1-状态,2-二者兼有 |
eventType |
int |
0-边沿触发,1-平延触发 |
localizd |
int |
0:云端 1:本地 3:云端化中 4:本地化中 |
abnormal |
int |
是否异常 0-正常,1-异常 |
positionId |
String |
位置id |
createTime |
long |
创建时间 |
updateTime |
long |
更新时间 |
{
"code": 0,
"message": "Success",
"msgDetails": "",
"requestId": "",
"result": {
"eventId": "CL.842499037874565120",
"localizd": 0,
"abnormal": 0,
"positionId": "real1.832621257077604352",
"createTime": 1620908886829,
"enable": 0,
"name": "name1",
"updateTime": 1620908886829,
"eventType": 1,
"triggerType": 0
}
}
通过对象id查询条件集
- 接口intent:query.event.listBySubjectId
- 接口描述:本接口可根据对象ID查询与其相关联的条件集列表。
- 请求参数
名称 |
类型 |
是否必须 |
描述 |
subjectId |
String |
是 |
对象id |
{
"intent": "query.event.listBySubjectId",
"data": {
"subjectId": "virtual2.55793119265827"
}
}
名称 |
类型 |
描述 |
eventId |
string |
条件集ID |
name |
String |
条件集名称 |
enable |
int |
条件集是否启用,0: 禁用 1: 启用 |
model |
String |
物模型 |
localizd |
int |
0:云端 1:本地 3:云端化中 4:本地化中 |
{
"code": 0,
"message": "Success",
"msgDetails": null,
"requestId": "",
"result": [
{
"eventId": "CL.862291336538177536",
"localizd": 0,
"enable": 1,
"name": "name1",
"model": "app.event.v1"
},
{
"eventId": "CL.848949590611304448",
"localizd": 0,
"enable": 1,
"name": "name5",
"model": "app.event.v1"
},
{
"eventId": "CL.848949449934348288",
"localizd": 0,
"enable": 1,
"name": "name4",
"model": "app.event.v1"
}
]
}
通过位置分页查询条件集
- 接口intent:query.event.listByPositionId
- 接口描述:本接口用于查询指定位置下的条件集列表。
- 请求参数
名称 |
类型 |
是否必须 |
描述 |
positionId |
String |
否 |
位置ID,为空查询用户下所有条件集 |
pageNum |
Int |
否 |
页码,默认值1 |
pageSize |
Int |
否 |
每页item个数,默认值50 |
{
"intent": "query.event.listByPositionId",
"data": {
"positionId": "real1.832621257077604352",
"pageSize": 50,
"pageNum": 1
}
}
名称 |
类型 |
描述 |
data |
Array(Object) |
条件集信息 |
totalCount |
int |
查询条件集数量 |
data说明:
名称 |
类型 |
描述 |
eventId |
string |
条件集ID |
name |
String |
条件集名称 |
enable |
int |
条件集是否启用,0: 禁用 1: 启用 |
model |
String |
物模型 |
positionId |
String |
位置id |
localizd |
int |
0:云端 1:本地 3:云端化中 4:本地化中 |
{
"code": 0,
"message": "Success",
"msgDetails": null,
"requestId": "5478.133.16248472111841629",
"result": {
"data": [
{
"eventId": "CL.844588721212261248",
"localizd": 1,
"positionId": "real1.720222961122087808",
"enable": 0,
"name": "name1111",
"model": "app.event.v1"
}
],
"totalCount": 1
}
}