Query Meta Measurement Point¶

Get meta measurement points by object type IDs.

Request Format¶

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

Request Parameters (URI)¶

Name	Location	Mandatory/Optional	Data Type	Description
orgId	Query	Mandatory	String	The organization ID which the measurement point belongs to. How to get orgId >>
mdmTypes	Query/Form	Optional	String	The object type ID which the measurement point belongs to. Separate multiple IDs by commas. Up to 100 object type IDs are allowed in a single query. How to get mdmTypes>>
mdmIds	Query/Form	Optional	String	The object instance ID which the measurement point belongs to. Separate multiple IDs by commas. Up to 20000 object instances are allowed in a single query. To ensure query performance, it is recommended that you pass in no more than 100 object instances 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.

Note

mdmTypes and mdmIds are both optional and you need to use at least one of them in a query. If both are used, mdmIds has a higher priority than mdmTypes.

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

Response Sample¶

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