List Generic Enumerate Meta Data¶

Get enumerate meta data by object type IDs or object IDs.

Request Format¶

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

Request Parameters¶

Name	Location	Mandatory/Optional	Data Type	Description
orgId	Query	Mandatory	String	The organization ID which the generic data belongs to. How to get orgId >>
mdmTypes	Query/Form	Optional	String	The object type ID which the generic data belongs to. Only one object type can be queried at a time.
mdmIds	Query/Form	Optional	String	The object instance ID which the generic data belongs to. Separate multiple IDs by commas. Up to 100 object instances are allowed in a single query. All of object ID must belong to single object type.
metaTypes	Query/Form	Optional	String	The type of the returned meta data. Use measurement-point, attribute, metric and dimension. Separate multiple types by commas.
elements	Query/Form	Mandatory	String	The object element IDs.Separate multiple IDs by commas. Up to 10 object elements are allowed in a single query.
locale	Query/Form	Optional	String	Use zh-CN, en-US, ja-JP, or es-ES. If not specified, the value is set to en_US by default.
withI18n	Query/Form	Optional	Boolean	Whether to return the internationalization content. The value is `true` or `false`. Default is false.

Note

mdmTypes and mdmIds are optional parameters, but at least one is required. If both parameters are specified at the same time, mdmIds takes precedence.

Response Content Type¶

application/json; charset = UTF-8

Response Parameters¶

Name	To Return Definitely/Conditionally	Data Type	Description
mdmType	Definitely	String	The object type ID which the generic data belongs to.
mdmIds	Conditionally	String	The object instance ID
metaTypes	Definitely	String	The type of the returned meta data. Use measurement-point, attribute, metric and dimension.
elements	Definitely	String	The object element IDs.
enumerate	Definitely	Map<String/enumerate key/, Enumerate Struct>	enumeration value.

Enumerate Struct¶

Name	To Return Definitely/Conditionally	Data Type	Description
name	Definitely	String	The name of the enumeration in the corresponding request language.
nameI18n	Conditionally	I18n Struct	Describe the internalization content of the enumeration.

Response Codes¶

See Common Data Service API Response Codes.

Samples¶

Request Sample¶

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

Response Sample¶

{
   "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"
}