IoTGateway/RESTful APIv2 - Revision history

Chinchen.lin at 03:10, 26 July 2016

2016-07-26T03:10:38Z

Chinchen.lin: /* Python */

2016-06-29T06:46:58Z

‎Python

Chinchen.lin: /* Javascript */

2016-06-29T06:46:28Z

‎Javascript

Chinchen.lin at 02:27, 29 June 2016

2016-06-29T02:27:41Z

Show changes

Chinchen.lin: /* REST Resource */

2016-06-29T02:25:46Z

‎REST Resource

Chinchen.lin: /* REST Resource */

2016-06-29T02:24:29Z

‎REST Resource

Chinchen.lin: /* Process Management Resources */

2016-06-28T06:56:05Z

‎Process Management Resources

Chinchen.lin: /* System Management Resources */

2016-06-28T06:55:02Z

‎System Management Resources

Chinchen.lin: /* Account Management Resources */

2016-06-28T06:53:41Z

‎Account Management Resources

Chinchen.lin: /* Retrieve all API resources, and API version. */

2016-06-28T06:52:47Z

‎Retrieve all API resources, and API version.

@@ Line 560: / Line 560: @@
                 "stat":"OPER",
                 "routing":"YES",
-                "reliablity":100,
+                "reliability":100,
                 "mslatency":0
              },

@@ Line 26: / Line 26: @@
    username = 'NAME'
    password = 'PWD'
-   url = 'http://localhost/restapi/AccountMgmt/AccountInfo'
+   url = <nowiki>'http://localhost/restapi/AccountMgmt/AccountInfo'</nowiki>
    base64string = base64.encodestring('%s:%s' % (username, password))[:-1]
    req = urllib2.Request(url)
@@ Line 39: / Line 39: @@
    username = 'NAME'
    password = 'PWD'
-   url = 'http://localhost/restapi/AccountMgmt/AccountConfig'
+   url = <nowiki>'http://localhost/restapi/AccountMgmt/AccountConfig'</nowiki>
    data = '{"username":"admin","password":"1234"}'
    base64string = base64.encodestring('%s:%s' % (username, password))[:-1]

@@ Line 182: / Line 182: @@
+   {
        type: put,
-       url: 'http://localhost/restapi/AccountMgmt/AccountConfig',
+       url: <nowiki>'http://localhost/restapi/AccountMgmt/AccountConfig'</nowiki>,
        data: '{"username":"admin","password":"1234"}',
        contentType: 'application/json',

@@ Line 242: / Line 242: @@
 == REST Resource ==
-[[File:Restfulapi2 resource.png]]
+[[File:Restfulapi2 resource.png|800px|frameless]]
 == Linear Dust WSN Resources ==

@@ Line 242: / Line 242: @@
 == REST Resource ==
-[[File:Restfulapi resource.png]]
+[[File:Restfulapi2 resource.png]]
 == Linear Dust WSN Resources ==

@@ Line 1,147: / Line 1,147: @@
 | URI Resource Path || /ProcessMgmt/Service
 |-
-| MQTT Topic Format|| /ProcessMgmt/<mac addr>/Service
+| Method|| GET
 |-
 | Request JSON Data|| N/A
@@ Line 1,299: / Line 1,297: @@
 |-
 | Example || curl -H "Content-Type: application/json" -X GET <nowiki>http://username:password@<IP:Port>/restapi/ProcessMgmt/Service</nowiki>
 |}
@@ Line 1,324: / Line 1,318: @@
 | URI Resource Path || /ProcessMgmt/ServiceConfig
 |-
-| MQTT Topic Format|| N/A
+| Method|| PUT
 |-
 | Request JSON Data||
@@ Line 1,347: / Line 1,339: @@
 |-
 | Example || curl -H "Content-Type: application/json" -X PUT -d '{"name":"xinetd","order":20,"onboot":1}' <nowiki>http://username:password@<IP:Port>/restapi/ProcessMgmt/ServiceConfig</nowiki>
 |}
 === Start and Stop service. ===
@@ Line 1,359: / Line 1,347: @@
 | URI Resource Path || /ProcessMgmt/ServiceCtrl
 |-
-| MQTT Topic Format|| N/A
+| Method|| POST
 |-
 | Request JSON Data||
@@ Line 1,377: / Line 1,363: @@
 |-
 | Example || curl -H "Content-Type: application/json" -X POST -d '{"name":"xinetd","action":"start"}' <nowiki>http://username:password@<IP:Port>/restapi/ProcessMgmt/ServiceCtrl</nowiki>
 |}

@@ Line 870: / Line 870: @@
 | URI Resource Path || /SystemMgmt/SystemInfo
 |-
-| MQTT Topic Format|| /SystemMgmt/<mac addr>/SystemInfo
+| Method|| GET
 |-
 | Request JSON Data|| N/A
@@ Line 933: / Line 931: @@
 |-
 | Example || curl -H "Content-Type: application/json" -X GET <nowiki>http://username:password@<IP:Port>/restapi/SystemMgmt/SystemInfo</nowiki>
 |}
@@ Line 982: / Line 977: @@
 | URI Resource Path || /SystemMgmt/NetworkInfo
 |-
-| MQTT Topic Format|| /SystemMgmt/<mac addr>/NetworkInfo
+| Method|| GET
 |-
 | Request JSON Data|| N/A
@@ Line 1,048: / Line 1,041: @@
 |-
 | Example || curl -H "Content-Type: application/json" -X GET <nowiki>http://username:password@<IP:Port>/restapi/SystemMgmt/NetworkInfo</nowiki>
 |}
@@ Line 1,080: / Line 1,070: @@
 | URI Resource Path || /SystemMgmt/NetworkConfig
 |-
-| MQTT Topic Format|| N/A
+| Method|| PUT
 |-
 | Request JSON Data||
@@ Line 1,101: / Line 1,089: @@
 |-
 | Example || curl -H "Content-Type: application/json" -X PUT -d '{"ipaddr":"172.22.12.38","netmask":"255.255.252.0"} "gateway":"172.22.12.1","method":"static","iface":"eth0"' <nowiki>http://username:password@<IP:Port>/restapi/SystemMgmt/NetworkConfig</nowiki>
 |}
@@ Line 1,127: / Line 1,112: @@
 | URI Resource Path || /SystemMgmt/Action
 |-
-| MQTT Topic Format|| N/A
+| Method|| POST
 |-
 | Request JSON Data||
@@ Line 1,145: / Line 1,128: @@
 | Example || curl -H "Content-Type: application/json" -X POST -d '{"action":"reboot","value":1}' <nowiki>http://username:password@<IP:Port>/restapi
 /SystemMgmt/Action</nowiki>
 |}

@@ Line 801: / Line 801: @@
 | URI Resource Path || /AccountMgmt/AccountInfo
 |-
-| MQTT Topic Format|| /AccountMgmt/<mac addr>/AccountInfo
+| Method|| GET
 |-
 | Request JSON Data|| N/A
@@ Line 823: / Line 821: @@
 |-
 | Example || curl -H "Content-Type: application/json" -X GET <nowiki>http://username:password@<IP:Port>/restapi/AccountMgmt/AccountInfo</nowiki>
 |}
@@ Line 848: / Line 843: @@
 | URI Resource Path || /AccountMgmt /AccountConfig
 |-
-| MQTT Topic Format|| N/A
+| Method|| PUT
 |-
 | Request JSON Data||
@@ Line 866: / Line 859: @@
 |-
 | Example || curl -H "Content-Type: application/json" -X PUT -d '{"username":"admin","password":"admin123"}' <nowiki>http://username:password@<IP:Port>/restapi/AccountMgmt/AccountConfig</nowiki>
 |}

@@ Line 671: / Line 671: @@
 | URI Resource Path || /APIInfoMgmt/APIInfo
 |-
-| Method|| GET/
+| Method|| GET
 |-
 | Request JSON Data|| N/A