CommandReflections Documentation
CommandReflections
Draft documentation version
Documentation is partial and not validated !
Description
Version | V1 |
---|---|
Require User context | |
Authorization | |
Errors |
Request
Route
Parameters
Parameter | Required | Sample | Description |
---|---|---|---|
WAC | WAC123456789012 | Code of BusinessAccount | |
Commands | Array of ReflectionCommandMultiple | ||
Description | My grouped command description | Description of grouped command | |
ExecutionDate | 2014-09-15T13:59:20.0000000Z | Execution planned date. If empty, commands are executed on next related LTU call | |
Name | My grouped command name | Name of grouped command | |
Tracking | Main | Ack and execution command tracking level as TrackingEnum |
Remarks
- To override Content-type in your clients HTTP Accept Header, append the
.json
suffix or?format=json
- To embed the response in a jsonp callback, append
?callback=myCallback
Post Data sample
POST /json/reply/CommandReflections HTTP/1.1
Host: localhost
Content-Type: application/json
Content-Length: length
{"wType":"CommandReflections","name":"String","description":"String","commands":[{"wType":"ReflectionCommandMultiple","command":{"wType":"ReflectionCommandBase"},"reflectionIDs":[0]}],"executionDate":"0001-01-01T00:00:00.0000000Z","tracking":"None","wac":"String"}
cURL command sample
curl -k -H "Authorization: Bearer [YOUR_ACCESS_TOKEN]" -H "Content-Type:application/json" -X POST -d @filename.json https://api.wit-datacenter.com/WAC123456789012/Reflection/CommandGroup
Remark
@filename.json
contain your request parameters serialized in JSON as described in Post Data sample bottom
Response
Returned Entity
Commands as Compact ReflectionCommandGroupJSON Sample
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"wType":"ReflectionCommandGroupShort","description":"String","phase":"New","execution":"0","creationDate":"0001-01-01T00:00:00.0000000Z","updateDate":"0001-01-01T00:00:00.0000000Z","planningDate":"0001-01-01T00:00:00.0000000Z","phaseProgression":0,"archived":false,"executionProgression":0,"executionSummary":[{"wType":"ReflectionCommandGroupExecutionSummary","executionStatus":"Awaiting","count":0}],"phaseSummary":[{"wType":"ReflectionCommandGroupPhaseSummary","phase":"Received","count":0}],"id":0,"picture":"00000000000000000000000000000000","name":"String"}