Hummingbird 文档

Appearance

物模型管理

创建物模型

功能介绍

调用该接口为指定产品的物模型新增功能。

URI

POST /v1.0/openapi/thingModel

请求参数

请求Header参数

参数 是否必选 参数类型 描述
x-token是String参数说明：用户Token。通过认证鉴权接口获取用户Token，接口返回的“access_token”就是用户Token。简要的获取方法样例请参见认证鉴权。

请求Body参数

参数 是否必选 参数类型 描述
product_id是String参数说明：产品ID。
properties否Array参数说明：物模型中的属性列表。关于属性数据结构中参数说明，请参见properties。
events否Array参数说明：物模型中的服务列表。关于事件数据结构中参数说明，请参见events。
services否Array参数说明：物模型中的事件列表。关于服务数据结构中参数说明，请参见services。
properties表
参数 是否必选 参数类型 描述
name是String参数说明：属性名称。
code是String参数说明：属性唯一标识符。
access_mode是String参数说明：属性读写类型：只读（r）或读写（rw）。
required是Bool参数说明：是否是标准功能的必选属性：是（true），否（false）。
type_spec.type是String参数说明：属性类型：int、float、text、date、bool、enum、struct、array。
type_spec.specs是String参数说明：属性描述。
description否String参数说明：描述。
events表
参数 是否必选 参数类型 描述
name是String参数说明：事件名称。
code是String参数说明：事件唯一标识符。
event_type是String参数说明：事件类型 info、alert、error。
required是Bool参数说明：是否是标准功能的必选属性：是（true），否（false）。
output_params是Array参数说明：输出参数。请参见output_params。
description否String参数说明：描述。
services表
参数 是否必选 参数类型 描述
name是String参数说明：服务名称。
code是String参数说明：服务唯一标识符。
required是Bool参数说明：是否是标准功能的必选属性：是（true），否（false）。
call_type是Bool参数说明：ASYNC（异步调用）或SYNC（同步调用）。
input_params否Array参数说明：输出参数。请参见input_params。
output_params否Array参数说明：输出参数。请参见output_params。
description否String参数说明：描述。
input_params表
参数 是否必选 参数类型 描述
name是String参数说明：名称。
code是String参数说明：唯一标识符。
type_spec.type是String参数说明：类型：int、float、text、date、bool、enum、struct、array。
type_spec.specs是String参数说明：物模型字段描述。
output_params表
参数 是否必选 参数类型 描述
name是String参数说明：名称。
code是String参数说明：唯一标识符。
type_spec.type是String参数说明：类型：int、float、text、date、bool、enum、struct、array。
type_spec.specs是String参数说明：描述。

响应参数

公共参数

参数 参数类型 描述
successBool参数说明：是否调用成功。
errorCodeInteger参数说明：调用失败时，返回的错误码，更多信息，请参见状态码。
errorMsgString参数说明：调用失败时，返回的出错信息。
resultObject参数说明：具体结果。

请求示例

json
curl --location 'http://127.0.0.1:58081/v1.0/openapi/thingModel' \
--header 'x-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJJRCI6MSwiVXNlcm5hbWUiOiJhZG1pbiIsImV4cCI6MTY4ODE5NzM0OSwiaXNzIjoiZWRnZS1nYXRld2F5IiwibmJmIjoxNjcwMDUyMzQ5fQ.NEBjrUrkSabtMuZjo4bzB3rzOT-zZ1YKxILLthFQ2wQ' \
--header 'Content-Type: application/json' \
--data '{
    "product_id": "5939599",
    "properties": [
        {
            "name": "线路用电电量",
            "code": "LineElectricityQuantity",
            "require": false,
            "access_mode": "R",
            "type_spec": {
                "type": "int",
                "specs": "{\"min\":\"1\",\"max\":\"30\",\"step\":\"1\",\"unitName\":\"无\"}"
            },
            "description": "描述"
        },
        {
            "name": "断路器分合闸状态",
            "code": "CircuitBreakerReclosingState",
            "require": false,
            "access_mode": "R",
            "type_spec": {
                "type": "bool",
                "specs": "{\"0\":\"分闸\",\"1\":\"合闸\"}"
            },
            "description": "描述"
        },
        {
            "name": "断路器类型",
            "code": "CircuitBreakerType",
            "require": false,
            "access_mode": "R",
            "type_spec": {
                "type": "enum",
                "specs": "{\"0\":\"220伏断路器\",\"1\":\"380伏断路器\"}"
            },
            "description": "描述"
        }
    ],
    "events": [
        {
            "name": "故障上报",
            "event_type": "info",
            "code": "Error",
            "description": "事件描述",
            "output_params": [
                {
                    "code": "ErrorCode",
                    "name": "故障代码",
                    "type_spec": {
                        "type": "enum",
                        "specs": "{\"0\":\"恢复正常\"}"
                    }
                }
            ]
        }
    ],
    "services": [
        {
            "name": "道闸操作",
            "code": "OperatGate",
            "require": false,
            "call_type": "SYNC",
            "input_params": [
                {
                    "code": "OperatType",
                    "name": "操作类型",
                    "type_spec": {
                        "type": "enum",
                        "specs": "{\"0\":\"关闸\",\"1\":\"开闸\",\"2\":\"长开\"}"
                    }
                }
            ],
            "output_params": [
                {
                    "code": "Result",
                    "name": "结果",
                    "type_spec": {
                        "type": "text",
                        "specs": "{\"length\":256}"
                    }
                }
            ],
            "description": "服务描述"
        }
    ]
}'

响应示例

json
{
    "success": true,
    "errorCode": 0,
    "errorMsg": "success",
    "result": []
}

更新物模型

功能介绍

调用该接口更新指定产品物模型信息。

URI

UPDATE /v1.0/openapi/thingModel

请求参数

请求Header参数

参数 是否必选 参数类型 描述
x-token是String参数说明：用户Token。通过认证鉴权接口获取用户Token，接口返回的“access_token”就是用户Token。简要的获取方法样例请参见认证鉴权。

请求Body参数

参数 是否必选 参数类型 描述
product_id是String参数说明：产品ID。
properties否Array参数说明：物模型中的属性列表。
events否Array参数说明：物模型中的服务列表。
services否Array参数说明：物模型中的事件列表。
properties表
参数 是否必选 参数类型 描述
id是String参数说明：产品属性ID。如果此参数为空，则代表新增属性。
name是String参数说明：属性名称。
code是String参数说明：属性唯一标识符。
access_mode是String参数说明：属性读写类型：只读（r）或读写（rw）。
required是Bool参数说明：是否是标准功能的必选属性：是（true），否（false）。
type_spec.type是String参数说明：属性类型：int、float、text、date、bool、enum、struct、array。
type_spec.specs是String参数说明：属性描述。
description否String参数说明：描述。
events表
参数 是否必选 参数类型 描述
id是String参数说明：产品事件ID。如果此参数为空，则代表新增事件。
name是String参数说明：事件名称。
code是String参数说明：事件唯一标识符。
event_type是String参数说明：事件类型 info、alert、error。
required是Bool参数说明：是否是标准功能的必选属性：是（true），否（false）。
output_params是Array参数说明：输出参数。请参见output_params。
description否String参数说明：描述。
services表
参数 是否必选 参数类型 描述
id是String参数说明：产品服务ID。如果此参数为空，则代表新增服务。
name是String参数说明：服务名称。
code是String参数说明：服务唯一标识符。
required是Bool参数说明：是否是标准功能的必选属性：是（true），否（false）。
call_type是Bool参数说明：ASYNC（异步调用）或SYNC（同步调用）。
input_params否Array参数说明：输出参数。请参见input_params。
output_params否Array参数说明：输出参数。请参见output_params。
description否String参数说明：描述。
input_params表
参数 是否必选 参数类型 描述
name是String参数说明：名称。
code是String参数说明：唯一标识符。
type_spec.type是String参数说明：类型：int、float、text、date、bool、enum、struct、array。
type_spec.specs是String参数说明：物模型字段描述。
output_params表
参数 是否必选 参数类型 描述
name是String参数说明：名称。
code是String参数说明：唯一标识符。
type_spec.type是String参数说明：类型：int、float、text、date、bool、enum、struct、array。
type_spec.specs是String参数说明：描述。

响应参数

公共参数

参数 参数类型 描述
successBool参数说明：是否调用成功。
errorCodeInteger参数说明：调用失败时，返回的错误码，更多信息，请参见状态码。
errorMsgString参数说明：调用失败时，返回的出错信息。
resultObject参数说明：具体结果。

请求示例

json
curl --location --request PUT 'http://127.0.0.1:58081/v1.0/openapi/thingModel' \
--header 'x-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJJRCI6MSwiVXNlcm5hbWUiOiJhZG1pbiIsImV4cCI6MTY4ODE5NzM0OSwiaXNzIjoiZWRnZS1nYXRld2F5IiwibmJmIjoxNjcwMDUyMzQ5fQ.NEBjrUrkSabtMuZjo4bzB3rzOT-zZ1YKxILLthFQ2wQ' \
--header 'Content-Type: application/json' \
--data '{
    "product_id": "3425533",
    "properties": [
        {
            "id": "3107217",
            "name": "线路用电电量",
            "code": "LineElectricityQuantity",
            "require": false,
            "access_mode": "R",
            "type_spec": {
                "type": "int",
                "specs": "{\"min\":\"1\",\"max\":\"30\",\"step\":\"1\",\"unitName\":\"无\"}"
            },
            "description": "描述"
        },
        {
            "id": "7450088",
            "name": "断路器分合闸状态",
            "code": "CircuitBreakerReclosingState",
            "require": false,
            "access_mode": "R",
            "type_spec": {
                "type": "bool",
                "specs": "{\"0\":\"分闸\",\"1\":\"合闸\"}"
            },
            "description": "描述"
        },
        {
            "id": "5308308",
            "name": "断路器类型",
            "code": "CircuitBreakerType",
            "require": false,
            "access_mode": "R",
            "type_spec": {
                "type": "enum",
                "specs": "{\"0\":\"220伏断路器\",\"1\":\"380伏断路器\"}"
            },
            "description": "描述"
        }
    ],
    "events": [
        {
            "id": "5539660",
            "name": "故障上报",
            "event_type": "info",
            "code": "Error",
            "description": "事件描述",
            "output_params": [
                {
                    "code": "ErrorCode",
                    "name": "故障代码",
                    "type_spec": {
                        "type": "enum",
                        "specs": "{\"0\":\"恢复正常\"}"
                    }
                }
            ]
        }
    ],
    "services": [
        {
            "id": "0107908",
            "name": "道闸操作",
            "code": "OperatGate",
            "require": false,
            "call_type": "SYNC",
            "input_params": [
                {
                    "code": "OperatType",
                    "name": "操作类型",
                    "type_spec": {
                        "type": "enum",
                        "specs": "{\"0\":\"关闸\",\"1\":\"开闸\",\"2\":\"长开\"}"
                    }
                }
            ],
            "output_params": [
                {
                    "code": "Result",
                    "name": "结果",
                    "type_spec": {
                        "type": "text",
                        "specs": "{\"length\":256}"
                    }
                }
            ],
            "description": "服务描述"
        }
    ]
}'

响应示例

json
{
    "success": true,
    "errorCode": 0,
    "errorMsg": "success",
    "result": []
}

查询物模型

功能介绍

调用该接口查询指定产品物模型信息。

URI

GET /v1.0/openapi/thingModel

请求参数

请求Header参数

参数 是否必选 参数类型 描述
x-token是String参数说明：用户Token。通过认证鉴权接口获取用户Token，接口返回的“access_token”就是用户Token。简要的获取方法样例请参见认证鉴权。

请求Query参数

参数 是否必选 参数类型 描述
product_id是String参数说明：产品ID。

响应参数

公共参数

参数 参数类型 描述
successBool参数说明：是否调用成功。
errorCodeInteger参数说明：调用失败时，返回的错误码，更多信息，请参见状态码。
errorMsgString参数说明：调用失败时，返回的出错信息。
resultObject参数说明：具体结果。

详情

参数 参数类型 描述
propertiesArray参数说明：物模型中的属性列表。关于属性数据结构中参数说明，请参见properties。
eventsArray参数说明：物模型中的服务列表。关于事件数据结构中参数说明，请参见events。
servicesArray参数说明：物模型中的事件列表。关于服务数据结构中参数说明，请参见services。
properties表
参数 参数类型 描述
idString参数说明：属性ID。
nameString参数说明：属性名称。
codeString参数说明：属性唯一标识符。
access_modeString参数说明：属性读写类型：只读（r）或读写（rw）。
requiredBool参数说明：是否是标准功能的必选属性：是（true），否（false）。
type_spec.typeString参数说明：属性类型：int、float、text、date、bool、enum、struct、array。
type_spec.specsString参数说明：属性描述。
descriptionString参数说明：描述。
events表
参数 参数类型 描述
idString参数说明：事件ID。
nameString参数说明：事件名称。
codeString参数说明：事件唯一标识符。
event_typeString参数说明：事件类型 info、alert、error。
requiredBool参数说明：是否是标准功能的必选属性：是（true），否（false）。
output_paramsArray参数说明：输出参数。请参见output_params。
descriptionString参数说明：描述。
services表
参数 参数类型 描述
nameString参数说明：服务名称。
codeString参数说明：服务唯一标识符。
requiredBool参数说明：是否是标准功能的必选属性：是（true），否（false）。
call_typeBool参数说明：ASYNC（异步调用）或SYNC（同步调用）。
input_paramsArray参数说明：输出参数。请参见input_params。
output_paramsArray参数说明：输出参数。请参见output_params。
descriptionString参数说明：描述。
input_params表
参数 参数类型 描述
nameString参数说明：名称。
codeString参数说明：唯一标识符。
type_spec.typeString参数说明：类型：int、float、text、date、bool、enum、struct、array。
type_spec.specsString参数说明：物模型字段描述。
output_params表
参数 参数类型 描述
nameString参数说明：名称。
codeString参数说明：唯一标识符。
type_spec.typeString参数说明：类型：int、float、text、date、bool、enum、struct、array。
type_spec.specsString参数说明：描述。

请求示例

json
curl --location 'http://127.0.0.1:58081/v1.0/openapi/thingModel?product_id=2939050' \
--header 'x-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJJRCI6MSwiVXNlcm5hbWUiOiJhZG1pbiIsImV4cCI6MTY4ODE5NzM0OSwiaXNzIjoiZWRnZS1nYXRld2F5IiwibmJmIjoxNjcwMDUyMzQ5fQ.NEBjrUrkSabtMuZjo4bzB3rzOT-zZ1YKxILLthFQ2wQ'

响应示例

json
{
    "success": true,
    "errorCode": 0,
    "errorMsg": "success",
    "result": {
        "properties": [
            {
                "id": "4602886",
                "name": "线路用电电量",
                "code": "LineElectricityQuantity",
                "access_mode": "R",
                "require": false,
                "type_spec": {
                    "type": "int",
                    "specs": "{\"min\":\"1\",\"max\":\"30\",\"step\":\"1\",\"unitName\":\"无\"}"
                },
                "description": "描述"
            },
            {
                "id": "4726134",
                "name": "断路器分合闸状态",
                "code": "CircuitBreakerReclosingState",
                "access_mode": "R",
                "require": false,
                "type_spec": {
                    "type": "bool",
                    "specs": "{\"0\":\"分闸\",\"1\":\"合闸\"}"
                },
                "description": "描述"
            },
            {
                "id": "3084503",
                "name": "断路器类型",
                "code": "CircuitBreakerType",
                "access_mode": "R",
                "require": false,
                "type_spec": {
                    "type": "enum",
                    "specs": "{\"0\":\"220伏断路器\",\"1\":\"380伏断路器\"}"
                },
                "description": "描述"
            },
            {
                "id": "1087114",
                "name": "线路用电电量",
                "code": "LineElectricityQuantity",
                "access_mode": "R",
                "require": false,
                "type_spec": {
                    "type": "int",
                    "specs": "{\"min\":\"1\",\"max\":\"30\",\"step\":\"1\",\"unitName\":\"无\"}"
                },
                "description": "描述"
            },
            {
                "id": "8604370",
                "name": "断路器分合闸状态",
                "code": "CircuitBreakerReclosingState",
                "access_mode": "R",
                "require": false,
                "type_spec": {
                    "type": "bool",
                    "specs": "{\"0\":\"分闸\",\"1\":\"合闸\"}"
                },
                "description": "描述"
            },
            {
                "id": "2578342",
                "name": "断路器类型",
                "code": "CircuitBreakerType",
                "access_mode": "R",
                "require": false,
                "type_spec": {
                    "type": "enum",
                    "specs": "{\"0\":\"220伏断路器\",\"1\":\"380伏断路器\"}"
                },
                "description": "描述"
            },
            {
                "id": "1894889",
                "name": "线路用电电量",
                "code": "LineElectricityQuantity",
                "access_mode": "R",
                "require": false,
                "type_spec": {
                    "type": "int",
                    "specs": "{\"min\":\"1\",\"max\":\"30\",\"step\":\"1\",\"unitName\":\"无\"}"
                },
                "description": "描述"
            },
            {
                "id": "3295444",
                "name": "断路器分合闸状态",
                "code": "CircuitBreakerReclosingState",
                "access_mode": "R",
                "require": false,
                "type_spec": {
                    "type": "bool",
                    "specs": "{\"0\":\"分闸\",\"1\":\"合闸\"}"
                },
                "description": "描述"
            },
            {
                "id": "9580745",
                "name": "断路器类型",
                "code": "CircuitBreakerType",
                "access_mode": "R",
                "require": false,
                "type_spec": {
                    "type": "enum",
                    "specs": "{\"0\":\"220伏断路器\",\"1\":\"380伏断路器\"}"
                },
                "description": "描述"
            }
        ],
        "events": [
            {
                "id": "1710553",
                "event_type": "info",
                "name": "故障上报",
                "code": "Error",
                "description": "事件描述",
                "require": false,
                "output_params": [
                    {
                        "code": "ErrorCode",
                        "name": "故障代码",
                        "type_spec": {
                            "type": "enum",
                            "specs": "{\"0\":\"恢复正常\"}"
                        }
                    }
                ]
            },
            {
                "id": "1374810",
                "event_type": "info",
                "name": "故障上报",
                "code": "Error",
                "description": "事件描述",
                "require": false,
                "output_params": [
                    {
                        "code": "ErrorCode",
                        "name": "故障代码",
                        "type_spec": {
                            "type": "enum",
                            "specs": "{\"0\":\"恢复正常\"}"
                        }
                    }
                ]
            },
            {
                "id": "7638221",
                "event_type": "info",
                "name": "故障上报",
                "code": "Error",
                "description": "事件描述",
                "require": false,
                "output_params": [
                    {
                        "code": "ErrorCode",
                        "name": "故障代码",
                        "type_spec": {
                            "type": "enum",
                            "specs": "{\"0\":\"恢复正常\"}"
                        }
                    }
                ]
            }
        ],
        "services": [
            {
                "id": "8625189",
                "name": "道闸操作",
                "code": "OperatGate",
                "description": "服务描述",
                "require": false,
                "call_type": "SYNC",
                "input_params": [
                    {
                        "code": "OperatType",
                        "name": "操作类型",
                        "type_spec": {
                            "type": "enum",
                            "specs": "{\"0\":\"关闸\",\"1\":\"开闸\",\"2\":\"长开\"}"
                        }
                    }
                ],
                "output_params": [
                    {
                        "code": "Result",
                        "name": "结果",
                        "type_spec": {
                            "type": "text",
                            "specs": "{\"length\":256}"
                        }
                    }
                ]
            },
            {
                "id": "7549973",
                "name": "道闸操作",
                "code": "OperatGate",
                "description": "服务描述",
                "require": false,
                "call_type": "SYNC",
                "input_params": [
                    {
                        "code": "OperatType",
                        "name": "操作类型",
                        "type_spec": {
                            "type": "enum",
                            "specs": "{\"0\":\"关闸\",\"1\":\"开闸\",\"2\":\"长开\"}"
                        }
                    }
                ],
                "output_params": [
                    {
                        "code": "Result",
                        "name": "结果",
                        "type_spec": {
                            "type": "text",
                            "specs": "{\"length\":256}"
                        }
                    }
                ]
            },
            {
                "id": "5757636",
                "name": "道闸操作",
                "code": "OperatGate",
                "description": "服务描述",
                "require": false,
                "call_type": "SYNC",
                "input_params": [
                    {
                        "code": "OperatType",
                        "name": "操作类型",
                        "type_spec": {
                            "type": "enum",
                            "specs": "{\"0\":\"关闸\",\"1\":\"开闸\",\"2\":\"长开\"}"
                        }
                    }
                ],
                "output_params": [
                    {
                        "code": "Result",
                        "name": "结果",
                        "type_spec": {
                            "type": "text",
                            "specs": "{\"length\":256}"
                        }
                    }
                ]
            }
        ]
    }
}

删除物模型

功能介绍

调用该接口删除指定产品物模型。

URI

DELETE /v1.0/openapi/thingModel

请求参数

请求Header参数

参数 是否必选 参数类型 描述
x-token是String参数说明：用户Token。通过认证鉴权接口获取用户Token，接口返回的“access_token”就是用户Token。简要的获取方法样例请参见认证鉴权。

请求Body参数

参数 是否必选 参数类型 描述
product_id是String参数说明：产品ID。
property_ids否Array参数说明：要删除产品下面属性ID列表。
event_ids否Array参数说明：要删除产品下面事件ID列表。
service_ids否Array参数说明：要删除产品下面服务ID列表。

响应参数

公共参数

参数 参数类型 描述
successBool参数说明：是否调用成功。
errorCodeInteger参数说明：调用失败时，返回的错误码，更多信息，请参见状态码。
errorMsgString参数说明：调用失败时，返回的出错信息。
resultObject参数说明：具体结果。

请求示例

json
curl --location --request DELETE 'http://127.0.0.1:58081/v1.0/openapi/thingModel' \
--header 'x-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJJRCI6MSwiVXNlcm5hbWUiOiJhZG1pbiIsImV4cCI6MTY4ODE5NzM0OSwiaXNzIjoiZWRnZS1nYXRld2F5IiwibmJmIjoxNjcwMDUyMzQ5fQ.NEBjrUrkSabtMuZjo4bzB3rzOT-zZ1YKxILLthFQ2wQ' \
--header 'Content-Type: application/json' \
--data '{
    "product_id": "2939050",
    "property_ids": [
        "4602886"
    ],
    "event_ids": [
        "1710553"
    ],
    "service_ids": [
        "8625189"
    ]
}'

响应示例

json
{
    "success": true,
    "errorCode": 0,
    "errorMsg": "success",
    "result": []
}