Get authorized objects

Get all of authorized objects with current login account.

Request Format

METHOD {URI-scheme}://{apigw-address}/solar-api/{version}/mdmService/getObjectStructure

Request Parameters

Name Location Required Datatype Description
type Query true String 102, only site is supported so far
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
attributes Query false String attributes using comma as splitter, empty means all of attributes
language Query false String language, Chinese: zh-CN, English: en-US, default as en-US

Response Parameters

Name Datatype Description
objectID String object 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/getObjectStructure?type=102&token=APP_PORTAL_S_DP57A********7NgxPQexKw

Response Example

{
    "data": [
        {
            "mdmid": "site 1",
            "attributes": {
                "parentID": "*******",
                "objectID": "*******",
                "updatedDate": "2018-01-26T18:03:40.306+0800",
                "objectTypeID": "102",
                "name": "*************",
                "businessType": "22",
                "isAttachedSite": "true",
                "createdDate": "2017-12-26T15:11:01.861+0800"
            }
        },
        {
            "mdmid": "site 2",
            "attributes": {
                "parentID": "*******",
                "objectID": "*******",
                "updatedDate": "2018-01-26T18:03:40.306+0800",
                "objectTypeID": "102",
                "name": "*************",
                "businessType": "22",
                "isAttachedSite": "true",
                "createdDate": "2017-12-26T15:11:01.861+0800"
            }
        },
    ],
   "status": 0,
   "msg": "OK"
}