设备定义API

设备相关的定义（服务属性、事件、方法）API

注：请先查看：API接口调用说明

设备服务定义

Request Url

{api_url}/deviceDefinition/service/find

Request Method
```
POST
```
Request Body

字段	值描述	必填
pdid	产品id	是
name	服务名称	否

示例：

{
    "pdid": "",
    "name": ""
}

Response Body

字段	值描述
sid	sid，服务定义id
name	服务定义名称
functionType	功能类型，0：标准，1：非标
status	状态，0：开发中，1：审核中，2：已上线
createDate	创建时间
updateDate	修改时间

示例：

{
    "status": 0,
    "description": "成功",
    "payload": [
        {
            "sid": 28,
            "name": "测试",
            "functionType": 1,
            "status": 2,
            "createDate": "2020-12-30 09:47:32",
            "updateDate": "2020-12-30 18:33:26"
        },
        {
            "sid": 29,
            "name": "test",
            "functionType": 1,
            "status": 2,
            "createDate": "2020-12-30 09:47:32",
            "updateDate": "2020-12-30 18:33:26"
        }
    ]
}

设备服务属性定义

Request Url

{api_url}/deviceDefinition/serviceParam/find

Request Method
```
POST
```
Request Body

字段	值描述	必填
pdid	产品id	是
sid	服务定义id	是

示例：

{
    "pdid": "",
    "sid": 1
}

Response Body

字段	值描述
sid	服务定义id
pid	属性定义id
name	属性定义名称
authority	权限值（按位存储的，类似于linux的文件权限），位一：读(1)，位二：写(2)，位三：上报(4)
format	格式，bool、uint8、uint16、uint32、int8、int16、int32、int64、float、string
valueDefinition	值内容定义说明
required	是否必选，0：非必选，1：必选
unit	单位
createDate	创建时间
updateDate	修改时间

示例：

{
    "status": 0,
    "description": "成功",
    "payload": [
        {
            "sid": 1,
            "pid": 0,
            "name": "test",
            "authority": 1,
            "format": "int32",
            "valueDefinition": "测试",
            "required": 0,
            "unit": null,
            "createDate": "2020-10-27 20:49:48",
            "updateDate": "2020-10-27 20:49:48"
        },
        {
            "sid": 1,
            "pid": 1,
            "name": "version",
            "authority": 1,
            "format": "string",
            "valueDefinition": "版本",
            "required": 1,
            "unit": "version",
            "createDate": "2020-10-27 20:52:40",
            "updateDate": "2020-10-27 20:52:40"
        }
    ]
}

设备事件定义

Request Url

{api_url}/deviceDefinition/event/find

Request Method
```
POST
```
Request Body

字段	值描述	必填
pdid	产品id	是
name	事件名称	否

示例：

{
    "pdid": "",
    "name": ""
}

Response Body

字段	值描述
sid	sid，事件定义id
name	事件定义名称
functionType	功能类型，0：标准，1：非标
status	状态，0：开发中，1：审核中，2：已上线
createDate	创建时间
updateDate	修改时间

示例：

{
    "status": 0,
    "description": "成功",
    "payload": [
        {
            "sid": 1,
            "name": "test1",
            "functionType": 0,
            "status": 2,
            "createDate": "2020-10-27 19:47:00",
            "updateDate": "2020-10-27 19:47:00"
        },
        {
            "sid": 2,
            "name": "test2",
            "functionType": 0,
            "status": 2,
            "createDate": "2020-10-27 19:47:15",
            "updateDate": "2020-10-27 19:47:15"
        }
    ]
}

设备事件参数定义

Request Url

{api_url}/deviceDefinition/eventParam/find

Request Method
```
POST
```
Request Body

字段	值描述	必填
pdid	产品id	是
sid	事件定义id	是

示例：

{
    "pdid": "",
    "sid": 1
}

Response Body

字段	值描述
sid	事件定义id
pid	参数定义id
name	参数定义名称
format	格式，bool、uint8、uint16、uint32、int8、int16、int32、int64、float、string
valueDefinition	值内容定义说明
required	是否必选，0：非必选，1：必选
createDate	创建时间
updateDate	修改时间

示例：

{
    "status": 0,
    "description": "成功",
    "payload": [
        {
            "sid": 2,
            "pid": 0,
            "name": "parameter1",
            "format": "string",
            "valueDefinition": "test1",
            "required": 0,
            "createDate": "2020-10-27 19:48:44",
            "updateDate": "2020-10-27 19:48:44"
        },
        {
            "sid": 2,
            "pid": 1,
            "name": "parameter2",
            "format": "bool",
            "valueDefinition": "test2",
            "required": 0,
            "createDate": "2020-11-06 00:15:15",
            "updateDate": "2020-11-06 00:15:20"
        }
    ]
}

设备方法定义

Request Url

{api_url}/deviceDefinition/action/find

Request Method
```
POST
```
Request Body

字段	值描述	必填
pdid	产品id	是
name	方法名称	否

示例：

{
    "pdid": "",
    "name": "测试"
}

Response Body

字段	值描述
sid	sid，方法定义id
name	方法定义名称
functionType	功能类型，0：标准，1：非标
status	状态，0：开发中，1：审核中，2：已上线
createDate	创建时间
updateDate	修改时间

示例：

{
    "status": 0,
    "description": "成功",
    "payload": [
        {
            "sid": 1,
            "name": "test1",
            "functionType": 0,
            "status": 2,
            "createDate": "2020-10-27 01:20:20",
            "updateDate": "2020-10-27 01:20:16"
        },
        {
            "sid": 2,
            "name": "test2",
            "functionType": 0,
            "status": 2,
            "createDate": "2020-10-27 17:35:40",
            "updateDate": "2020-10-27 17:35:40"
        }
    ]
}

设备方法参数定义

Request Url

{api_url}/deviceDefinition/actionParam/find

Request Method
```
POST
```
Request Body

字段	值描述	必填
pdid	产品id	是
sid	方法定义id	是

示例：

{
    "pdid": "",
    "sid": 1
}

Response Body

字段	值描述
sid	方法定义id
pid	参数定义id
name	参数定义名称
format	格式，bool、uint8、uint16、uint32、int8、int16、int32、int64、float、string
valueDefinition	值内容定义说明
required	是否必选，0：非必选，1：必选
paramType	参数类型，0：输入，1：输出
createDate	创建时间
updateDate	修改时间

示例：

{
    "status": 0,
    "description": "成功",
    "payload": [
        {
            "sid": 1,
            "pid": 1,
            "name": "test1",
            "format": "bool",
            "valueDefinition": "test1",
            "required": 1,
            "paramType": 0,
            "createDate": "2020-10-28 10:35:06",
            "updateDate": "2020-10-28 10:35:06"
        },
        {
            "sid": 1,
            "pid": 0,
            "name": "test2",
            "format": "float",
            "valueDefinition": "test2",
            "required": 1,
            "paramType": 0,
            "createDate": "2020-10-28 10:20:56",
            "updateDate": "2020-10-28 10:20:56"
        }
    ]
}

设备定义API

设备定义API

设备服务定义

设备服务属性定义

设备事件定义

设备事件参数定义

设备方法定义

设备方法参数定义

results matching ""

No results matching ""