Recent changes to UpdateSingleCommand

UpdateSingleCommand modified by Jim

Jim — Wed, 03 Jan 2018 22:09:15 -0000

--- v2
+++ v3
@@ -1,4 +1,4 @@
-### Update Command ###
+### Update Single Command ###

 changes the command in the domain of an owner identified by the apikey
 the full command is replaced, not a delta to the existing one
@@ -38,13 +38,14 @@
 Example

 ~~~~~~
-PUT http://localhost/cs-ws/resources/admin/command/?apikey=1234 HTTP/1.1
+PUT http://localhost/cs-ws/resources/admin/command?apikey=1234 HTTP/1.1
 
    <name>TempDev2</name>
    <actor>Valve1</actor>
    <id>8</id>
    <status>Ok</status>
    <activation_time>2012-08-31 21:56:54.036</activation_time>
+   <execution_time>2012-08-31 22:56:54.036</execution_time>
    <parameter>
       <name>WaterValve</name>
       <value>2.0</value>

WikiPage UpdateCommand modified by Jim

Jim — Sun, 23 Sep 2012 09:56:17 -0000

--- v1
+++ v2
@@ -13,44 +13,32 @@
 Data
 
 ~~~~~~
-
-   ...
-   ..
-                   optional device configuration parameters
-      ...
-      ...
-   
-   ...
-                   optional if sensor configuration parameters are set
-      ...     
-                   
-         ...
-         ...
-      
-      ...
-   
-   ...
-                    optional if actor configuration parameters are set
-      ...     
-                   
-         ...
-         ...
-      
-      ...
-   
-   ...
-
+
+   ...                        device name
+   ...                      actor name
+   ...                            unique number
+   ...                    New, Sent, Ok or Failed
+   ...  
+       time when command should be executed as yyyy-mm-dd hh:mm:ss.SSS
+       it is guaranteed that command is not sent before activation time
+   ...  
+       time when command was executed as yyyy-mm-dd hh:mm:ss.SSS
+                                parameters as defined in actor model
+       ...
+       ...
+   
+
 ~~~~~~
 
 Errors:
 
 * 401 UNAUTHORIZED if key is invalid or not admin key
-* 404 NOT FOUND if the device model  in the post data is not existing
+* 404 NOT FOUND if the command  in the post data is not existing
 
 Example
 
 ~~~~~~
-PUT http://localhost/cs-ws/resources/admin/device/?apikey=1234 HTTP/1.1
+PUT http://localhost/cs-ws/resources/admin/command/?apikey=1234 HTTP/1.1
 
    TempDev2
    Valve1

WikiPage UpdateCommand modified by Jim

Jim — Sun, 23 Sep 2012 09:51:20 -0000

### Update Command ### changes the command in the domain of an owner identified by the apikey the full command is replaced, not a delta to the existing one Path: cs-ws/resources/admin/command Method: PUT Alternative: cs-ws/resources/admin/command/put Method: POST Parameters * apikey Data ~~~~~~ ... .. optional device configuration parameters ... ... ... optional if sensor configuration parameters are set ... ... ... ... ... optional if actor configuration parameters are set ... ... ... ... ... ~~~~~~ Errors: * 401 UNAUTHORIZED if key is invalid or not admin key * 404 NOT FOUND if the device model in the post data is not existing Example ~~~~~~ PUT http://localhost/cs-ws/resources/admin/device/?apikey=1234 HTTP/1.1 TempDev2 Valve1 8 Ok 2012-08-31 21:56:54.036 WaterValve 2.0 HTTP/1.1 200 OK ~~~~~~