Restful Api Rules; Supported Request Method; Get Request Components; Put Request Components - Moxa Technologies ioThinx 4510 Series User Manual

ioThinx 4510 Series

RESTful API Rules

Supported Request Method

Request Description
GET The GET method is used to retrieve information from the given server using a given URI.
Requests using GET should only retrieve data and should have no other effect on the data.
PUT Replaces all the current representations of the target resource with the uploaded content.
OPTIONS Describe the communication options for the target resource.

GET Request Components

Component
Request Method
URL
Headers

PUT Request Components

Component
Request Method
URL
Headers
Body

RESTful API List

Here lists the RESTful APIs supported by this device. The {ioName} is composed with three elements,
including Module_Name, @, and I/O_Channel_Name. For example, the {ioName} of the module name
"45MR-1600-0" and the DI channel name "DI-00" is 45MR-1600-0@DI-00.
RESTful API
/api/sysInfo
/api/sysInfo/device
/api/sysInfo/network
/api/sysInfo/network/LAN
/api/sysInfo/network/LAN/1
/api/io/ir/{ioName}
/api/io/ir/{ioname}/irvalue
/api/io/sp/{ioName}/spStatus
/api/io/sp/{ioName}/spLowerLimitValue
Content
GET
http://{IP address}/{RESTful API} Refer to RESTful API List
Accept: vdn.dac.v2
Content-Type: application/json
Content
PUT
http://{IP address}/{RESTful API} Refer to RESTful API List
Accept: vdn.dac.v2
Content-Type: application/json
{"value":1}
Description
Use GET request to retrieve information
Headers are mandatory for all RESTful API requests
Description
Use PUT request to replace current representation
Headers are mandatory for all RESTful API requests
Uploaded content for replacing current
representation
Description
All system information
Device name
Device local date and time
Device up time
Firmware version
Serial number
System error
All network information
All LAN information
MAC address
IP address
IR - value
IR - value
SP - system power Status
SP - system power lower
limit value
A-10
Appendix
Access Format
R
R
R yyyy/mm/dd
hh:mm:ss
R hh:mm:ss
R
R
R
R
R
R xx:xx:xx:xx:xx:xx
R xxx.xxx.xxx.xxx
R By data type
RW By data type
R 0, 1, 2
R Float