NeoEdge X OT Device RESTful API

NeoEdge X provides a RESTful API that allows 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 into your application system.

Read OT Device Tag Value
curl -X 'GET' 'http://:59882/api/v3/device/name//' | jq '.event.readings[0]'
Reply content
{
    "id": "5522d833-8383-48a5-b8ed-7a534a701ef3",
    "origin": ,
    "deviceName": "",
    "resourceName": "",
    "profileName": "",
    "valueType": "",
    "value": ""
}
Field Name
Explanation

origin

Data acquisition timestamp, in ns

device name

OT Device Name

resourceName

OT Tag Name

profileName

OT Profile Name, default value is -profile

valueType

OT Tag Type

According to the configured tag data type, possible values are:

[“Boolean”, “Int16”, “Int32”, “Int64”, “UInt16”, “UInt32”, “UInt64”, “Float32”, “Float64”, “String”]
value Tag's read value
Write OT Device Tag Value
curl -X 'PUT' 'http://:59882/api/v3/device/name//' \
     -H 'Content-Type: application/json' \
     -d '{"":}'
Reply content
{
  "apiVersion": "v3",
  "statusCode": 200
}
Field Name
Explanation

statusCode

HTTP status codes

Related Posts