NeoEdge X OT Device RESTful API

NeoEdge X provides RESTful APIs that allow your external applications to read device data and send control commands to operate OT devices. This document explains how to use the NeoEdge X RESTful API and defines each field to help you integrate it seamlessly into your application system.

Reading OT Device Tag Values

curl -X 'GET' 'http://<Gatewap_IP>:59882/api/v3/device/name/<Device_Name>/<Tag_Nme>' | jq '.event.readings[0]'

Response

{
    "id": "5522d833-8383-48a5-b8ed-7a534a701ef3",
    "origin": <timestamp>,
    "deviceName": "<Device_Name>",
    "resourceName": "<Tag_Name>",
    "profileName": "<Porfile_Name>",
    "valueType": "<Tag_Type>",
    "value": "<Tag_Value>"
}

寫入OT Device Tag 數值

curl -X 'PUT' 'http://<Gatewap_IP>:59882/api/v3/device/name/<Device_Name>/<Tag_Nme>' \
     -H 'Content-Type: application/json' \
     -d '{"<Tag_Nme>":<New_Value>}'

Response

{
  "apiVersion": "v3",
  "statusCode": 200
}