IoTGateway/RESTful APIv2 QuickGuide - Revision history

Chinchen.lin at 00:49, 2 June 2016

2016-06-02T00:49:36Z

Chinchen.lin at 00:49, 2 June 2016

2016-06-02T00:49:00Z

Chinchen.lin at 00:48, 2 June 2016

2016-06-02T00:48:23Z

Show changes

Chinchen.lin at 00:43, 2 June 2016

2016-06-02T00:43:24Z

Chinchen.lin at 00:42, 2 June 2016

2016-06-02T00:42:37Z

Chinchen.lin: /* API Management Resources */

2016-06-01T08:57:18Z

‎API Management Resources

Chinchen.lin at 08:48, 1 June 2016

2016-06-01T08:48:34Z

Chinchen.lin at 08:45, 1 June 2016

2016-06-01T08:45:36Z

Chinchen.lin: /* Process Management Resources */

2016-06-01T08:38:44Z

‎Process Management Resources

Chinchen.lin: /* Process Management Resources */

2016-06-01T08:36:41Z

‎Process Management Resources

@@ Line 13: / Line 13: @@
 MQTT Topic: <code><resource path></code>
-MQTT response is not include <code>‘{"result": }’</code>
+MQTT response is not include <code>{"result": }</code>
 == Linear Dust WSN Resources ==

@@ Line 5: / Line 5: @@
 RESTful API:  <code><nowiki>http://<ip address>:port/restapi/<resource path> </nowiki></code>
-Default Port: 3000
+Default Port: <code>3000</code>
-Default User Name: admin
+Default User Name: <code>admin</code>
-Default Password: admin
+Default Password: <code>admin</code>
-MQTT Topic: <resource path>
+MQTT Topic: <code><resource path></code>
-MQTT response is not include ‘{"result": }’
+MQTT response is not include <code>‘{"result": }’</code>
 == Linear Dust WSN Resources ==

@@ Line 52: / Line 52: @@
+  }
 |-
-| Example || curl -H "Content-Type: application/json" -X GET http://username:password@<IP:Port>/restapi/WSNMgmt/IoTGW/WSN/<mac addr>/Setting
+| Example || curl -H "Content-Type: application/json" -X GET <nowiki>http://username:password@<IP:Port>/restapi/WSNMgmt/IoTGW/WSN/<mac addr>/Setting</nowiki>
 |-
 | Example || mosquito_sub -h <IP> -C 1 -t /WSNMgmt/IoTGW/WSN/<mac addr>/Setting
 |}
 === Set a new Network ID for the WSN manager. ===
 {| class="wikitable"

@@ Line 3: / Line 3: @@
 Every URL relates to a specific resource or list of resources.
-RESTful API:  http://<ip address>:port/restapi/<resource path>
+RESTful API:  <code><nowiki>http://<ip address>:port/restapi/<resource path> </nowiki></code>
 Default Port: 3000

@@ Line 525: / Line 525: @@
 |-
 | Example || mosquito_sub -h <IP> -C 1 -t /APIInfoMgmt/<mac addr>/APIInfo
 |}

@@ Line 16: / Line 16: @@
 == Linear Dust WSN Resources ==
-=== 1.Retrieve the WSN manager setting information. ===
+=== Retrieve the WSN manager setting information. ===
 {| class="wikitable"
 |-
@@ Line 56: / Line 56: @@
 | Example || mosquito_sub -h <IP> -C 1 -t /WSNMgmt/IoTGW/WSN/<mac addr>/Setting
 |}
-=== 2.Set a new Network ID for the WSN manager. ===
+=== Set a new Network ID for the WSN manager. ===
 {| class="wikitable"
 |-
@@ Line 84: / Line 84: @@
 | Example || mosquitto_pub -h <IP> -m '{"sv":"1234"}' -t /WSNMgmt/IoTGW/WSN/<mac addr>/Setting/NetID
 |}
-=== 3.Set a new Join Key for the WSN manager. ===
+=== Set a new Join Key for the WSN manager. ===
 {| class="wikitable"
 |-
@@ Line 111: / Line 111: @@
 | Example || mosquitto_pub -h <IP> -m '{"sv":"DUSTNETWORKSROCK"}' -t /WSNMgmt/IoTGW/WSN/<mac addr>/Setting/JoinKey
 |}
-=== 4.Retrieve the WSN manager information. ===
+=== Retrieve the WSN manager information. ===
 {| class="wikitable"
 |-
@@ Line 167: / Line 167: @@
 | Example || mosquito_sub -h <IP> -C 1 -t /WSNMgmt/IoTGW/WSN/<mac addr>/Info
 |}
-=== 5.Reset the WSN manager. ===
+=== Reset the WSN manager. ===
 {| class="wikitable"
 |-
@@ Line 194: / Line 194: @@
 | Example || mosquitto_pub -h <IP> -m '{"bv":1}' -t /WSNMgmt/IoTGW/WSN/<mac addr>/Info/reset
 |}
-=== 6.Retrieve the WSN Network Statistics. ===
+=== Retrieve the WSN Network Statistics. ===
 {| class="wikitable"
 |-
@@ Line 243: / Line 243: @@
 | Example || mosquito_sub -h <IP> -C 1 -t /WSNMgmt/IoTGW/WSN/<mac addr>/NetworkStatistics
 |}
-=== 7.Retrieve the Sensor Hub information. ===
+=== Retrieve the Sensor Hub information. ===
 {| class="wikitable"
 |-
@@ Line 286: / Line 286: @@
 |}
-=== 8.Set the Sensor Hub name. ===
+=== Set the Sensor Hub name. ===
 {| class="wikitable"
 |-
@@ Line 315: / Line 315: @@
 |}
-=== 9.Reset the Sensor Hub. ===
+=== Reset the Sensor Hub. ===
 {| class="wikitable"
 |-
@@ Line 343: / Line 343: @@
 | Example || mosquitto_pub -h <IP> -m '{"bv":1}' -t /WSNMgmt/<mac addr>/SenHub/Info/reset
 |}
-=== 10.Retrieve the Sensor Hub available action. ===
+=== Retrieve the Sensor Hub available action. ===
 {| class="wikitable"
 |-
@@ Line 375: / Line 375: @@
 | Example || mosquito_sub -h <IP> -C 1 -t /WSNMgmt/<mac addr>/SenHub/Action
 |}
-=== 11.Set the Sensor Hub to AutoReport. ===
+=== Set the Sensor Hub to AutoReport. ===
 {| class="wikitable"
 |-
@@ Line 404: / Line 404: @@
 |}
-=== 12.Retrieve the Sensor Hub all sensor data. ===
+=== Retrieve the Sensor Hub all sensor data. ===
 {| class="wikitable"
 |-
@@ Line 445: / Line 445: @@
 |}
-=== 13.Retrieve the Sensor Hub network information. ===
+=== Retrieve the Sensor Hub network information. ===
 {| class="wikitable"
 |-
@@ Line 490: / Line 490: @@
 == API Management Resources ==
-=== 1.Retrieve all API resources, and API version. ===
+=== Retrieve all API resources, and API version. ===
 {| class="wikitable"
 |-
@@ Line 528: / Line 528: @@
 == Account Management Resources ==
-=== 1.Retrieve all accounts information. ===
+=== Retrieve all accounts information. ===
 {| class="wikitable"
 |-
@@ Line 575: / Line 575: @@
 | lastchange|| Account last change time.
 |}
-=== 2.Change account password. ===
+=== Change account password. ===
 {| class="wikitable"
 |-
@@ Line 607: / Line 607: @@
 == System Management Resources ==
-=== 1.Retrieve system information. ===
+=== Retrieve system information. ===
 {| class="wikitable"
 |-
@@ Line 719: / Line 719: @@
 | disk.part.usage|| Device disk usage.
 |}
-=== 2.Retrieve network information. ===
+=== Retrieve network information. ===
 {| class="wikitable"
 |-
@@ Line 818: / Line 818: @@
 | mac|| Device MAC address.
 |}
-=== 3.Edit network settings. ===
+=== Edit network settings. ===
 {| class="wikitable"
 |-
@@ Line 865: / Line 865: @@
 | method|| DHCP or Static IP.
 |}
-=== 4.Set device "reboot" by action. ===
+=== Set device "reboot" by action. ===
 {| class="wikitable"
 |-
@@ Line 905: / Line 905: @@
 == Process Management Resources ==
-=== 1.Retrieve all services information. ===
+=== Retrieve all services information. ===
 {| class="wikitable"
 |-
@@ Line 1,082: / Line 1,082: @@
 | onboot|| Service on boot or not.
 |}
-=== 2.Edit service settings. ===
+=== Edit service settings. ===
 {| class="wikitable"
 |-
@@ Line 1,118: / Line 1,118: @@
 |}
-=== 3.Start and Stop service. ===
+=== Start and Stop service. ===
 {| class="wikitable"
 |-

← Older revision		Revision as of 08:38, 1 June 2016
Line 1,112:		Line 1,112:
	\| Example \|\| MQTT N/A		\| Example \|\| MQTT N/A

		+	\|}
		+
		+	{\| class="wikitable"
		+	\|-
		+	\| Description \|\| '''Start and Stop service.'''
		+	\|-
		+	\| URI Resource Path \|\| /ProcessMgmt/ServiceCtrl
		+	\|-
		+	\| MQTT Topic Format\|\| N/A
		+	\|-
		+	\| Method(HTTP)\|\| POST
		+	\|-
		+	\| Request JSON Data\|\|
		+	{
		+	"name":"xinetd",
		+	"action":"start"
		+	}
		+
		+	\|-
		+	\| Response JSON Data\|\|
		+	{
		+	"result":"true"
		+	}
		+
		+	\|-
		+	\| Example \|\| curl -H "Content-Type: application/json" -X POST -d '{"name":"xinetd","action":"start"}' http://username:password@<IP:Port>/restapi
		+	/ProcessMgmt/ServiceCtrl
		+
		+	\|-
		+	\| Example \|\| MQTT N/A
		+
		+	\|}
		+
		+	{\| class="wikitable"
		+	\|-
		+	! Item !! Description
		+	\|-
		+	\| name\|\| Service name.
		+	\|-
		+	\| action\|\| Start or Stop service.
	\|}		\|}

@@ Line 1,062: / Line 1,062: @@
 |-
 | Example || mosquito_sub -h <IP> -C 1 -t /ProcessMgmt/<mac addr>/Service
 |}