获取产品模型定义

文档信息

字段 内容
关联产品 [[DTS]]
服务名称 Microservice-DigitalTwin-Center
接口类型 对外开放接口
协议类型 HTTP
当前版本 v1.0.0
维护人 产品组
适用对象 后端开发 / 第三方集成商

服务接口简介

获取产品Profile信息。

接口信息

项 内容
方法 POST
路径 /bv-microservice-digitaltwin-center/product/getProfile
协议 HTTP
是否鉴权 是
幂等性 否
超时时间建议 5s

请求参数

请求体：

字段 类型 是否必填 说明 示例
productId true 否 productId -

响应参数

字段 类型 说明 示例
code integer(int32) - 0
info ProductProfile - {"events": [{"abstractId": "", "dataDefinition": {}, "dataType": "", "eventDescription": "", "eventId": "", "eventIdentifier": "", "eventName": "", "eventPersistentStorage": 0, "eventQos": 0, "eventRequired": 0, "eventType": 0, "outputData": [{"dataTypeModel": {"specs": {}, "type": ""}, "description": "", "identifier": "", "name": ""}], "templateId": ""}], "link": "", "productAccessGatewayProtocol": 0, "productDataFormat": 0, "productId": "", "properties": [{"addTime": "", "dataDefinition": {}, "dataType": "", "dataTypeModel": {"specs": {}, "type": ""}, "propertyDescription": "", "propertyId": "", "propertyIdentifier": "", "propertyName": "", "propertyReadWrite": 0, "propertyRequired": 0, "propertyValue": ""}], "schema": "", "services": [{"callbackMethod": 0, "callbackUrl": "", "dataDefinition": {}, "dataType": "", "gatewayEnvironmentId": "", "inputData": [{}], "interfaceResponseMode": 0, "interfaceUrl": "", "outputData": [{}], "serviceDescription": "", "serviceId": "", "serviceIdentifier": "", "serviceName": "", "serviceRequired": 0, "targetEventIdentifier": ""}]}
events array - [{"abstractId": "", "dataDefinition": {}, "dataType": "", "eventDescription": "", "eventId": "", "eventIdentifier": "", "eventName": "", "eventPersistentStorage": 0, "eventQos": 0, "eventRequired": 0, "eventType": 0, "outputData": [{"dataTypeModel": {"specs": {}, "type": ""}, "description": "", "identifier": "", "name": ""}], "templateId": ""}]
abstractId string 摘要模板id -
dataDefinition object 数据定义 -
dataType string 数据类型 -
eventDescription string 描述 -
eventId string 事件id -
eventIdentifier string 标识符 -
eventName string 名称 -
eventPersistentStorage integer 是否持久化存储 0 否 1 是 -
eventQos integer 消息质量 0 默认 1 一级 2 二级 -
eventRequired integer 是否为标准功能的必选 0 可选 1 必选 2 自定义 -
eventType integer 事件类型 0 消息 1 告警 -
outputData array 输出参数 -
dataTypeModel DataTypeModel - -
specs object 类型约束定义 -
type string 数据类型 -
description string - -
identifier string - -
name string - -
templateId string 关联模板id -
link string - -
productAccessGatewayProtocol integer(int32) - 0
productDataFormat integer(int32) - 0
productId string - -
properties array - [{"addTime": "", "dataDefinition": {}, "dataType": "", "dataTypeModel": {"specs": {}, "type": ""}, "propertyDescription": "", "propertyId": "", "propertyIdentifier": "", "propertyName": "", "propertyReadWrite": 0, "propertyRequired": 0, "propertyValue": ""}]
addTime string 属性值更新时间 -
dataDefinition object 数据定义 -
dataType string 数据类型 -
dataTypeModel DataTypeModel 数据类型对象 -
specs object 类型约束定义 -
type string 数据类型 -
propertyDescription string 描述 -
propertyId string 属性id -
propertyIdentifier string 标识符 -
propertyName string 名称 -
propertyReadWrite integer 读写类型 0 读写 1 只读 -
propertyRequired integer 是否为标准功能的必选 0 可选 1 必选 2 自定义 -
propertyValue string 属性值 -
schema string - -
services array - [{"callbackMethod": 0, "callbackUrl": "", "dataDefinition": {}, "dataType": "", "gatewayEnvironmentId": "", "inputData": [{}], "interfaceResponseMode": 0, "interfaceUrl": "", "outputData": [{}], "serviceDescription": "", "serviceId": "", "serviceIdentifier": "", "serviceName": "", "serviceRequired": 0, "targetEventIdentifier": ""}]
callbackMethod integer 回调方式 0 无 1 Http 2 Redis 3 属性上报 4 事件上报 -
callbackUrl Redis时必传） 回调地址（回调方式为Http -
dataDefinition object 数据定义 -
dataType string 数据类型 -
gatewayEnvironmentId string 网关环境编号 -
inputData array 输入参数 -
dataTypeModel DataTypeModel - -
specs object 类型约束定义 -
type string 数据类型 -
description string - -
identifier string - -
name string - -
interfaceResponseMode integer 第三方服务接口响应方式 0 同步 1 异步 2 流式 -
interfaceUrl string 第三方服务接口地址 -
outputData array 输出参数 -
dataTypeModel DataTypeModel - -
specs object 类型约束定义 -
type string 数据类型 -
description string - -
identifier string - -
name string - -
serviceDescription string 描述 -
serviceId string 服务编号 -
serviceIdentifier string 服务标识符 -
serviceName string 服务名称 -
serviceRequired integer 是否为标准功能的必选 0 可选 1 必选 2 自定义 -
targetEventIdentifier string 目标事件标识符（当回调方式为事件上报时存在，当前产品下） -
message string - -

响应示例：

{
    "code": 0,
    "info": {
        "events": [
            {
                "abstractId": "",
                "dataDefinition": {},
                "dataType": "",
                "eventDescription": "",
                "eventId": "",
                "eventIdentifier": "",
                "eventName": "",
                "eventPersistentStorage": 0,
                "eventQos": 0,
                "eventRequired": 0,
                "eventType": 0,
                "outputData": [
                    {
                        "dataTypeModel": {
                            "specs": {},
                            "type": ""
                        },
                        "description": "",
                        "identifier": "",
                        "name": ""
                    }
                ],
                "templateId": ""
            }
        ],
        "link": "",
        "productAccessGatewayProtocol": 0,
        "productDataFormat": 0,
        "productId": "",
        "properties": [
            {
                "addTime": "",
                "dataDefinition": {},
                "dataType": "",
                "dataTypeModel": {
                    "specs": {},
                    "type": ""
                },
                "propertyDescription": "",
                "propertyId": "",
                "propertyIdentifier": "",
                "propertyName": "",
                "propertyReadWrite": 0,
                "propertyRequired": 0,
                "propertyValue": ""
            }
        ],
        "schema": "",
        "services": [
            {
                "callbackMethod": 0,
                "callbackUrl": "",
                "dataDefinition": {},
                "dataType": "",
                "gatewayEnvironmentId": "",
                "inputData": [
                    {}
                ],
                "interfaceResponseMode": 0,
                "interfaceUrl": "",
                "outputData": [
                    {}
                ],
                "serviceDescription": "",
                "serviceId": "",
                "serviceIdentifier": "",
                "serviceName": "",
                "serviceRequired": 0,
                "targetEventIdentifier": ""
            }
        ]
    },
    "message": ""
}

调用示例

curl 示例：

curl -X POST "http://<Host>/bv-microservice-digitaltwin-center/product/getProfile" \
  -H "bv-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

接口错误码

错误码 HTTP 状态 场景 处理建议
200 200 创建成功 (返回产品Profile) 成功
201 201 Created (资源已创建) 创建成功
401 401 未授权 (需要认证信息) 请登录通用用户系统获取 API Key，并在 Header 中携带 bv-api-key
403 403 禁止访问 (权限不足) 请检查该 API Key 是否被授权访问该接口
404 404 接口不存在 (检查接口地址) 检查接口 URL 是否正确

备注

  • 前置条件：API Key 已在“通用用户系统”中创建并关联了相应的 DTS 权限。
  • 副作用：无。
作者：北京-产品-yantings  创建时间：2025-11-26 09:12
最后编辑：北京-产品-yantings  更新时间：2026-07-07 18:15
上一篇：
下一篇：