Appearance
queryEvent
根据事件Id查询事件详情数据
使用说明
暂无
接口地址
/gateway/openapi
请求方式
POST
请求参数
请求头
| 名称 | 类型 | 描述 |
|---|---|---|
| tokenauthorization | String | 平台颁发的token |
| apiCode | String | 固定值:queryEvent |
请求参数
QueryEventRequest
| 名称 | 类型 | 是否必选 | 描述 |
|---|---|---|---|
| eventId | String | 是 | 事件id |
返回数据
QueryProductEventResponse
| 名称 | 类型 | 描述 |
|---|---|---|
| code | String | 调用成功,返回0,调用失败,查看错误信息。 |
| msg | String | 调用成功,提示"操作成功",调用失败,查看错误信息。 |
| data | Object | 返回结果。结果内容详情,查看下方示例。 |
data
| 名称 | 类型 | 描述 |
|---|---|---|
| eventId | String | 事件id |
| blockId | String | 模块id |
| custom | String | 是否自定义功能,0:不是,1:是 |
| name | String | 功能名称 |
| pid | String | 功能标识 |
| eventType | String | 事件类型(info、alert、error) |
| eventDesc | String | 事件描述 |
| required | String | 是否必须,0:可选,1:必须 |
| eventDesc | String | 描述信息 |
| paramBeans | List | 属性参数数据 |
paramBeans
| 名称 | 类型 | 描述 |
|---|---|---|
| paramId | String | 主键编号 |
| name | String | 功能名称 |
| pid | String | 功能标识 |
| inputOutput | String | 参数类型,是输入参数还是输出参数,命令特有的字段,input:输入参数,output:输出参数 |
| parentId | String | 结构体参数有嵌套,但是要注意不允许嵌套中再有嵌套 |
| type | String | 字段数据类型,int(原生)、float(原生)、double(原生)、text(原生)、date(String类型UTC毫秒)、bool(0或1的int类型)、enum(int类型,枚举项定义方法与bool类型定义0和1的值方法相同)、struct(结构体类型,可包含前面7种类型,下面使用'specs':[{}]描述包含的对象)、array(数组类型,支持int、double、float、text、struct) |
| specsMin | String | 参数最小值(int、float、double类型特有) |
| specsMax | String | 参数最大值(int、float、double类型特有) |
| specsUnit | String | 属性单位(int、float、double类型特有,非必填) |
| specsUnitName | String | 单位名称(int、float、double类型特有,非必填) |
| specsSize | int | 数组元素的个数,最大512(array类型特有) |
| specsStep | String | 步长(text、enum类型无此参数) |
| specsLength | int | 数据长度,最大10240(text类型特有) |
| specsBoolFalse | String | 0的值(bool类型特有) |
| specsBoolTrue | String | 1的值(bool类型特有) |
| specsItemType | String | 数组元素的类型(array类型特有) |
| specsEnum | String | enum类型数据体,结构示例, key:value;key2:value2 |
示例
请求示例
json
{
"eventId": "2ace60c8df674d3dbd42892cd9964c57"
}返回示例
json
{
"code": "0",
"msg": "操作成功",
"data": {
"eventId": "2ace60c8df674d3dbd42892cd9964c57",
"blockId": "c8c17b2f4f874545bc5159cd22317b22",
"custom": "1",
"pid": "aaa",
"name": "关闭",
"eventType": "alert",
"required": "0",
"method": "event.aaa.post",
"eventDesc": null,
"paramBeans": [
{
"paramId": "bbc48ebe8ea84376b86073bd641c7a1f",
"functionId": "2ace60c8df674d3dbd42892cd9964c57",
"pid": "aa",
"name": "说",
"inputOutput": "output",
"parentId": null,
"type": "int32",
"specsMin": "1",
"specsMax": "25",
"specsUnit": null,
"specsUnitName": "d7d9ef70de17411c946fb9e62e081baf",
"specsSize": 0,
"specsStep": "1",
"specsLength": 0,
"specsBoolFalse": null,
"specsBoolTrue": null,
"specsItemType": null,
"specsEnum": null
}
]
}
}