Query Meta Attribute¶

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

请求格式¶

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

请求参数¶

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

返回内容类型¶

application/json; charset = UTF-8

响应参数 ¶

名称	必然/可能返回	数据类型	描述
mdmType	必然返回	String	属性所属的对象类型。
modelId	可能返回	String	属性关联的模型的标识符。
attribute	必然返回	String	属性的标识符。
name	必然返回	String	请求语言中属性的名称。
nameI18n	可能返回	I18n 结构体	描述属性的国际化名称。参见 I18n 结构体。
type	必然返回	String	属性的数据类型。
units	可能返回	String	属性的单位。
expression	可能返回	String	虚拟属性的表达式。
mdmAggMethods	可能返回	String	属性的对象类型聚合方式。
groups	可能返回	Map（Key 为 String，Value 为 Group 结构体）	属性的可视化分组信息。参见 Group 结构体。
enumerate	可能返回	Map（Key 为 String，Value 为 Enumerate 结构体）	枚举类属性的枚举值。参见 Enumerate 结构体。
source	必然返回	String	属性的来源。CDS 表示来自通用数据服务的虚拟属性，MODEL 表示模型属性，AMC 表示属性来自配置中心。
subSource	可能返回	String	描述属性为公有属性或私有属性。

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/attribute?action=query&orgId=yourOrgId&mdmTypes=yourMdmType

返回示例¶

{
   "data":[
         {
            "mdmType":"yourMdmType",
            "modelId": "yourMdmId",
            "name":"Commissioning Date",
            "attribute":"operativeDate",
            "units":"--",
            "type":"date"
         },
         {
            "mdmType":"yourMdmType",
            "modelId": "yourMdmId",
            "name":"Onboarding Date",
            "attribute":"etlDate",
            "units":"--",
            "type":"date"
         },
         {
            "mdmType":"yourMdmType",
            "modelId": "yourMdmId",
            "name":"objectTypeID",
            "attribute":"objectTypeID",
            "units":"--",
            "type":"string"
         },
         {
            "mdmType":"yourMdmType",
            "modelId": "yourMdmId",
            "name":"Unit Price",
            "attribute":"correctedPrice",
            "units":"--",
            "type":"Double"
         }
   ],
   "code":0,
   "msg":"OK",
   "traceId": "1234567890abcdefghijkl0987654321"
}