Query Meta Metric¶

Get meta metrics by object type IDs.

Request Format¶

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

Request Parameters¶

Name	Location	Mandatory/Optional	Data Type	Description
orgId	Query	Mandatory	String	The organization ID which the metric belongs to. How to get orgId >>
mdmTypes	Query	Mandatory	String	The object type ID which the metric belongs to. Separate multiple IDs by commas. Up to 100 object type IDs are allowed in a single query. How to get mdmTypes>>
locale	Query	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	Optional	Boolean	Whether to return the internationalization content.
withDataSourceInfo	Query	Optional	Boolean	Whether to return the information of data source.

Response Content Type¶

application/json; charset = UTF-8

Response Codes¶

See Common Data Service API Response Codes.

Samples¶

Request Sample¶

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

Response Sample¶

{
   "data":[
        {
            "mdmType":"yourMdmType",
            "metric": "activeProduction",
            "name": "Active Production",
            "units": "kWh",
            "type": "Double",
            "interval": "D,M,Y,T",
            "mdmAggMethods": "sum",
            "accumulativePoint": "SITE.ActiveProduction",
            "dimensions": "inverterModel,inverterMfr",
            "dataSources": "SolarAPI,OLAPAPI"
        },
        {
            "mdmType":"yourMdmType",
            "metric": "SITE.StringDownLossRecoverable",
            "name": "Recoverable Down String Loss",
            "units": "kWh",
            "type": "Double",
            "interval": "D,M,Y,T",
            "mdmAggMethods": "sum"
        },
        {
            "mdmType":"yourMdmType",
            "metric": "SITE.PR",
            "name": "Performance Ratio",
            "units": "%",
            "type": "Double",
            "interval": "D,M,Y,T",
            "expression": "#{Metric['SITE.PR150_Numerator'] / Metric['SITE.PR150_Denominator']}",
            "standardType": "illegal",
            "filters": ">,>=",
            "sortable": false,
            "dataSources": "SolarAPI",
            "dataSourceCapability": {
                "dimensionFilter": "2",
                "pagination": "1",
                "mdmGroup": "1",
                "virtualDimension": "1",
                "dimensionSort": "2",
                "metricSort": "2",
                "metricFilter": "2",
                "rollup": "1"
            }
        }
   ],
   "code":0,
   "msg":"OK",
   "traceId": "1234567890abcdefghijkl0987654321"
}