Axelta REST API Reference

Structure of the REST URIs

1. Store Device Data
URL /services/data
Method POST
Content Type application/json
URL Parameters NA
Playload
{
  "device_no":[string],
  "node_no":[string],
  "device_key":[string],
  "client":[string],
  "device_type":[string],
  "timestamp":[cuurent epoch timestamp]
  "Parmeter1":[any value],
  "Parmeter2":[any value]
.
.
.
.
.
}
Required :
device_no, node_no, device_key, client, device_type
                                                                
Success Response 200: OK
Error Response 401: Unauthorized
415: Unsupported Media Type
453: JSON Key is Invalid!
2. Get the list of device data
URL /services/node/getTransactions
Method GET
Content Type NA
URL Parameters
 ?user_name=[your login user name]&device_no=[device number]&node_no=[node number]&limit=[limit]
 Required :
 user_name=[string]
 device_no=[device number]
 node_no=[node number]
 limit=[integer]
                                                                
Playload NA
Success Response
     
200: OK
Content :
   [{
      "timestamp":1461060591,
      "device_key":"XXXXXXXX",
      "client":"XXXXXX",
      "device_no":"XXXXXX",
      "device_type":"XXXXX",
      "node_no":"XXXX",
      .
      .
      .....
     }, {

      "timestamp":1461060524,
      "device_key":"XXXXXXXX",
      "client":"XXXXXX",
      "device_no":"XXXXXX",
      "device_type":"XXXXX",
      "node_no":"XXXX"  
      .
      .
      .....
     }, {
      "timestamp":1461060481,
      "device_key":"XXXXXXXX",
      "client":"XXXXXX",
      "device_no":"XXXXXX",
      "device_type":"XXXXX",
      "node_no":"XXXX"  
      .
      .
      .....
     }
     .
     .
     .....
   ]

NOTE : If there no data the response content will be ‘[]’
NOTE : For Unauthorized request the response will be empty
Error Response 415: Unsupported Media Type
3.update Device Node Metadata
URL /services/device/updateNodeMetaData/<user name>/<client key>
Method POST
Content Type application/json
URL Parameters NA
Playload
{
"device_no": "<device nomber>",
"node_no": "<node number>",
"update": {
"<Metdata name1>": "<value1>",
"<Metdata name2>": "<value2>",
"<Metdata name3>": "<value3>",
.
.
.
.
}
}
                                                                
Success Response 200: OK
Error Response 302: Not Modiefied
400: Invalid JSON Format!
400: Invalid Details
400: The object ‘update’ is missing
400: The object ‘update’ must be a json
401: Unauthorized
415: Unsupported Media Type
4.Get Node details
URL /services/device/deviceNodeAsset/<vclient name>/<username>/<client key>
Method GET
Content Type NA
URL Parameters NA
Playload NA
Success Response
     
200: OK
Content :
   [{
"device_no": "XXXXX",
"node_data": [{
"node_no": "XXX_1",
"asset name": "XXX_1",
.
.
.
}, {
"node_no": "XXX_2",
"asset name": "XXX_2",
.
.
.
},
.
.
.
]
}, {
"device_no": "XXXXX_1",
"node_data": [{
....
...
},
.....
....
]
},
....
...
.
]
                                                                
Error Response 401: Unauthorized
5.Get Device Node Metadata
URL /services/devicetype/getDeviceNodeMetaDataList/<device number>
Method GET
Content Type NA
URL Parameters NA
Playload NA
Success Response
     
200: OK
Content :
   {
/*device configurations*/
"client": "XXXXX",
...
..
.
/* node details, configrations*/
"node_data": [{
"node_no": "XXX_2",
"asset name": "XXX_2",
.
.
.
}, {
"node_no": "XXX_3",
"asset name": "XXX_3",
.
.
.
},
.
.
.
]
}
                                                                
Error Response 401: Unauthorized
6.Update Heartbeat Configurations
URL /services/device/updateHeartbeatConfigs/<user name>/<client>
Method POST
Content Type application/json
URL Parameters NA
Playload
{
{

"device_no": "<device nomber>",
"node_no": "<node number>",
"update": {
" heartbeat_flag :[true/false],
.
.
.
}
}
                                                                    
Success Response 200: OK
Error Response 302: Not Modiefied
400: Invalid JSON Format!
400: Invalid Details
400: The object ‘update’ is missing
400: The object ‘update’ must be a json
401: Unauthorized
415: Unsupported Media Type