Query Meta Measurement Point¶

根据对象类型标识符等信息获取测点元数据。

请求格式¶

GET/POST https://{api-gateway}/cds-meta-service/v1.0/measurement-point?action=query

请求参数（URI）¶

名称	位置	必需/可选	数据类型	描述
orgId	Query	必需	String	测点所属的组织 ID。如何获取 orgId 信息>>
mdmTypes	Query/Form	可选	String	测点所属的对象类型的标识符，多个对象类型之间用英文逗号隔开。单次查询指定的对象类型数量不超过 100。如何获取 mdmTypes 信息>>
mdmIds	Query/Form	可选	String	测点对应的对象实例的标识符，多个对象实例之间用英文逗号隔开。单次查询指定的对象实例数量不超过 20000。为保证查询性能，建议单次查询指定的对象实例数量不超过 100。
locale	Query/Form	可选	String	中文：zh-CN, 英文：en-US, 日语：ja-JP，西班牙语：es-ES。默认为 en-US。
withI18n	Query/Form	可选	Boolean	是否返回完整的国际化内容，`true` 为返回，`false` 为不返回。默认不返回。
withElementGroupInfo	Query/Form	可选	Boolean	是否返回可视化分组信息。默认返回。
applyDataFilter	Query/Form	可选	Boolean	是否在返回结果中过滤无数据上送的测点。默认不过滤。

备注

mdmTypes 和 mdmIds 均为可选参数，但至少需要使用一个。若同时指定了两个参数，优先使用 mdmIds。

返回内容类型¶

application/json; charset = UTF-8

响应参数 ¶

名称	必然/可能返回	数据类型	描述
mdmType	必然返回	String	测点所属的对象类型。
modelId	可能返回	String	测点关联的模型的标识符。
measurementPoint	必然返回	String	测点的标识符。
name	必然返回	String	请求语言中测点的名称。
nameI18n	可能返回	I18n 结构体	描述测点的国际化名称。参见 I18n 结构体。
type	必然返回	String	测点的数据类型。
units	可能返回	String	测点的单位。
expression	可能返回	String	虚拟测点的表达式。
mdmAggMethods	必然返回	String	测点的对象类型聚合方式。
timeAggMethods	必然返回	String	测点的时间聚合方式。
interval	必然返回	String	测点支持的查询间隔，例如 RAW、5m、10m。
signalType	必然返回	String	测点的类型，例如 AI、DI。
amcFlag	可能返回	String	测点的配置中心标签。
groups	可能返回	Map（Key 为 String，Value 为 Group 结构体）	测点的可视化分组信息。参见 Group 结构体。
enumerate	可能返回	Map（Key 为 String，Value 为 Enumerate 结构体）	枚举类测点的枚举值。参见 Enumerate 结构体。
tags	可能返回	Tag 结构体	描述测点的标签。
source	必然返回	String	测点的来源。CDS 表示来自通用数据服务的虚拟测点，MODEL 表示模型测点，AMC 表示测点来自配置中心。
subSource	可能返回	String	描述测点为公有测点或私有测点。
hasTimeSeries	必然返回	Boolean	测点是否包含时序数据。`true` 表示包含，`false` 表示不包含。

I18n 结构体 ¶

名称	必然/可能返回	数据类型	描述
defaultValue	必然返回	String	默认内容。
en_US	可能返回	String	英文内容。
zh_CN	可能返回	String	中文内容。
es_ES	可能返回	String	西班牙语内容。
ja_JP	可能返回	String	日语内容。

Group 结构体 ¶

名称	必然/可能返回	数据类型	描述
groupName	必然返回	String	请求语言中可视化分组的名称。
groupNameI18n	可能返回	I18n 结构体	描述可视化分组的国际化名称。参见 I18n 结构体。
groupOrder	必然返回	Integer	可视化分组的顺序。
elementName	必然返回	String	请求语言中可视化分组内元素的名称。
elementNameI18n	可能返回	I18n 结构体	描述元素的国际化名称。参见 I18n 结构体。
elementOrder	必然返回	Integer	可视化分组内元素的顺序。
area	必然返回	Map（Key 为 String，Value 为 Area 结构体）	可视化分组内的分类信息。参见 Area 结构体。

Area 结构体 ¶

名称	必然/可能返回	数据类型	描述
areaName	必然返回	String	请求语言中分类的名称。
areaNameI18n	可能返回	I18n 结构体	描述分类的国际化名称。参见 I18n 结构体。
areaOrder	必然返回	Integer	分类的顺序。

Enumerate 结构体 ¶

名称	必然/可能返回	数据类型	描述
name	必然返回	String	请求语言中枚举值的名称。
nameI18n	可能返回	I18n 结构体	描枚举值的国际化名称。参见 I18n 结构体。

返回码¶

参见通用数据服务 API 返回码。

示例¶

请求示例¶

GET https://{api-gateway}/cds-meta-service/v1.0/measurement-point?action=query&orgId=yourOrgId&mdmTypes=yourMdmType

返回示例¶

{
   "data":[
         {
            "mdmType":"yourMdmType",
            "modelId": "yourModelId",
            "name": "Site Active Power",
            "units": "kW",
            "type": "Double",
            "measurementPoint": "SITE.GenActivePW",
            "timeAggMethods": "avg,sum,max,min,first,last",
            "mdmAggMethods": "sum",
            "interval":"5,15,60",
            "accumulable": false,
            "signalType": "AI"
        },
        {
            "mdmType":"yourMdmType",
            "modelId": "yourModelId",
            "name": "Site POA",
            "units": "W/m²",
            "type": "Double",
            "measurementPoint": "SITE.Radiation",
            "timeAggMethods": "avg,sum,max,min,first,last",
            "mdmAggMethods": "sum",
            "interval":"5,15,60",
            "accumulable": true,
            "signalType": "AI"
        }
   ],
   "code":0,
   "msg":"OK",
   "traceId": "1234567890abcdefghijkl0987654321"
}