- Documentation
- Master Data Service
- Get objects and related child device
Get objects and related child device¶
Get devices and related child device with detail info.
Request Format¶
METHOD {URI-scheme}://{apigw-address}/solar-api/{version}/mdmService/getObjects
Request Parameter¶
Name | Location | Required | Datatype | Description |
---|---|---|---|---|
mdmids | Query | true | String | mdm ids with comma as splitter |
token | Query | false | String | token, required when user account calls Solar API |
orgId | Query | false | String | orgnization Id, required when service account calls Solar API |
types | Query | false | String | device types, empty means all of device types. See device list on Solar API overview for details. |
attributes | Query | false | String | attributes, empty means all of attributes |
language | Query | false | String | lauguage,Chinese: zh-CN, English: en-US, default as en-US |
Response Parameters¶
Name | Datatype | Description |
---|---|---|
objectID | String | object id(i.e. device id, mdm id) |
name | String | object name |
other attributes… | String | other attributes… |
Error Codes¶
See Common response code.
Example¶
Request Example¶
GET
https://{apigw-address}/solar-api/v1.0/mdmService/getObjects?mdmids=LnxxxxxG&token=APP_PORTAL_S_DP57A********7NgxPQexKw
Response Example¶
{
"data": {
"LnxxxxxG": {
"mdmobjects": {
"207":[
{
"mdmid":"arx****sY",
"attributes": {
"objectTypeID": "207",
"modelId": "EnOS_Solar_CombinerBox",
"timezone": "+08:00",
"name": "N409HL102-15",
"branches": "2,3,4,5,6,7,8,9,10,11,12,13,14,15,16",
"topoParentDeviceID": "ELNZj0yP",
"modelIdPath": "/EnOS_Solar_CombinerBox",
"objectID": "arx****sY",
"parentID": "LnxxxxxG",
"branchMax": "16"
}
}
],
"102": [
{
"mdmid": "LnxxxxxG",
"attributes": {
"altitude": "4.0",
"timezone": "+08:00",
"longitude": "121.0846",
"objectID": "LnxxxxxG"
}
}
]
}
}
},
"status": 0,
"msg": "OK"
}