Appearance
pageListFunction
根据产品key与模块id获取功能数据分页接口
使用说明
暂无
接口地址
/gateway/openapi
请求方式
POST
请求参数
请求头
名称 | 类型 | 描述 |
---|---|---|
tokenauthorization | String | 平台颁发的token |
apiCode | String | 固定值:pageListFunction |
请求参数
PageRequest
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
current | int | 否 | 页码从1开始,默认为1 |
size | int | 否 | 每页大小数,默认为20 |
orderBy | String | 否 | 排序字段,默认:create_time |
queryVO | Object | 是 | 查询对象 |
--productKey | String | 是 | 产品key |
--blockId | String | 否 | 模块id 不填为默认模块 |
返回数据
PageInfo
名称 | 类型 | 描述 |
---|---|---|
code | String | 调用成功,返回0,调用失败,查看错误信息。 |
msg | String | 调用成功,提示"操作成功",调用失败,查看错误信息。 |
data | Object | 返回结果。结果内容详情,查看下方示例。 |
data 分页信息返回
名称 | 类型 | 描述 |
---|---|---|
current | int | 当前页 |
size | int | 每页大小 |
pages | int | 总页数 |
total | int | 当前返回的数据数量 |
records | List | 当前返回的数据 |
records
名称 | 类型 | 描述 |
---|---|---|
blockId | String | 模块id |
custom | String | 是否自定义功能,0:不是,1:是 |
functionId | String | 功能id(属性、命令、事件) |
functionType | String | 功能类型 属性:'property' 事件:'event' 命令:'command' |
name | String | 功能名称 |
pid | String | 功能标识 |
required | String | 是否必须,0:可选,1:必须 |
operateType | String | 是否必须,0:可选,1:必须 |
dataType | String | 数据类型 |
dataDefinition | String | 数据定义 |
accessMode | String | 访问权限属性才有值,r:只读,rw:读写 |
示例
请求示例
json
{
"current": 1,
"orderBy": "create_time",
"queryVO": {
"productKey": "F4wg3MgrM"
},
"size": 20
}
返回示例
json
{
"code": "0",
"msg": "操作成功",
"data": {
"current": 1,
"size": 20,
"pages": 1,
"total": 1,
"records": [
{
"blockId": "68ec1b53df1d4ce69c0a36887f28e5c4",
"custom": "1",
"functionId": "4fbf6d8e90ef42909746abc00fd68df8",
"functionType": "property",
"name": "状态",
"pid": "status",
"required": "0",
"operateType": "",
"dataType": "int32",
"dataDefinition": "取值范围:1 ~ 10",
"accessMode": "r"
}
]
}
}