CommandReflectionSystem Documentation
CommandReflectionSystem
Draft documentation version
Documentation is partial and not validated !
Description
Version | V1 |
---|---|
Require User context | |
Authorization | |
Errors |
Request
Route
Parameters
Parameter | Required | Sample | Description |
---|---|---|---|
Command | e@sy sytem command as ReflectionCommandSystem | ||
ReflectionID | 6 | ID of ReflectionBase to command | |
WAC | WAC123456789012 | Code of BusinessAccount | |
ExecutionDate | 2014-09-15T13:59:20.0000000Z | Execution planned date. If empty, command is executed on next LTU call | |
Tracking | Main | Ack and execution command tracking level as TrackingEnum |
Remarks
- To override Content-type in your clients HTTP Accept Header, append the
.jsv
suffix or?format=jsv
- To embed the response in a jsonp callback, append
?callback=myCallback
Post Data sample
POST /jsv/reply/CommandReflectionSystem HTTP/1.1
Host: localhost
Content-Type: text/jsv
Content-Length: length
{
wType: CommandReflectionSystem,
command:
{
wType: ReflectionCommandSystem,
scenario: WDCToLTU_K2APP,
tracking: None,
option: Restart,
location: String,
fileID: 0,
global: False
},
reflectionID: 0,
executionDate: 0001-01-01,
tracking: None,
wac: String
}
cURL command sample
curl -k -H "Authorization: Bearer [YOUR_ACCESS_TOKEN]" -H "Content-Type:application/jsv" -X POST -d @filename.jsv https://api.wit-datacenter.com/WAC123456789012/Reflection/6/CommandSystem
Remark
@filename.jsv
contain your request parameters serialized in JSV as described in Post Data sample bottom
Response
Returned Entity
Command as ReflectionDataSystemJSV Sample
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { wType: ReflectionDataSystem, scenario: 0, freeFlashSize: 0, freeRAMSize: 0, connectedExt: 0, executionCode: 0, executionStatus: Awaiting, option: Restart, location: String, fileID: 0, global: False, creationDate: 0001-01-01, sendDate: 0001-01-01, executionDate: 0001-01-01, phase: Received, state: 0, id: 0, picture: 00000000000000000000000000000000, name: String }