List Generic Enumerate Meta Data¶

根据对象类型或对象标识符等信息获取测点、属性、指标、维度的枚举信息。

请求格式¶

GET/POST https://{api-gateway}/cds-meta-service/v1.0/enumerate

请求参数¶

名称	位置	必需/可选	数据类型	描述
orgId	Query	必需	String	数据所属的组织 ID。如何获取 orgId 信息>>
mdmType	Query/Form	可选	String	数据所属的对象类型的标识符，一次只能查询一个对象类型。
mdmIds	Query/Form	可选	String	数据对应的对象实例的标识符，多个对象实例之间用英文逗号隔开。单次查询指定的对象实例数量不超过 100。所有对象实例必须属于一个对象类型。
metaTypes	Query/Form	必需	String	元数据类型，目前支持 `measurement-point`、`attribute`、`metric`、`dimension`。多个类型之间用英文逗号隔开。
elements	Query/Form	必需	String	业务对象要素（测点、属性、指标、维度）的 ID，多个业务对象要素之间用英文逗号隔开。单次查询指定的业务对象要素数量不超过 10。
locale	Query/Form	可选	String	中文：zh-CN, 英文：en-US, 日语：ja-JP，西班牙语：es-ES。默认为 en-US。
withI18n	Query/Form	可选	Boolean	是否返回完整的国际化内容，`true` 为返回，`false` 为不返回。默认不返回。

注解

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

返回内容类型¶

application/json; charset = UTF-8

响应参数¶

名称	必然/可能返回	数据类型	描述
mdmType	必然返回	String	数据所属的对象类型。
mdmIds	可能返回	String	数据对应的对象实例的标识符。
metaTypes	必然返回	String	元数据类型，例如测点、属性、指标、维度。
elements	必然返回	String	业务对象要素（测点、属性、指标、维度）的ID。
enumerate	必然返回	Map<String/enumerate key/, Enumerate Struct>	枚举值信息。

枚举结构体¶

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

返回码¶

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

示例¶

请求示例¶

GET https://{api-gateway}/cds-meta-service/v1.0/enumerate?action=query&
orgId=yourOrgId&mdmTypes=yourMdmType&metaType=yourMetaType&elements=yourElements

返回示例¶

{
   "data":[
            {
                "mdmType":"yourMdmType",
                "mdmId":"yourMdmId",
                "metaType": "dimension",
                "element": "yourDimension",
                "enumerate": {
                    "yourEnumValue": {
                        "nameI18n": {
                            "defaultValue": "yourEnumValue",
                            "i18nValue": {}
                        },
                        "name": "yourEnumValue"
                    },
                    "yourEnumValue": {
                        "nameI18n": {
                            "defaultValue": "yourEnumValue",
                            "i18nValue": {}
                        },
                        "name": "yourEnumValue"
                    }
                }
            },
            {
                "mdmType":"yourMdmType",
                "mdmId":"yourMdmId",
                "metaType": "measurementPoint",
                "element": "yourMeasurementPoint",
                "enumerate": {
                    "yourEnumValue": {
                        "nameI18n": {
                            "defaultValue": "yourEnumValue",
                            "i18nValue": {}
                        },
                        "name": "yourEnumValue"
                    },
                    "yourEnumValue": {
                        "nameI18n": {
                            "defaultValue": "yourEnumValue",
                            "i18nValue": {}
                        },
                        "name": "yourEnumValue"
                    }
                }
            }
   ],
   "code":0,
   "msg":"OK"
}