CancelReflectionCommandGroup Documentation
CancelReflectionCommandGroup
Draft documentation version
Documentation is partial and not validated !
Description
Remark
Each inner ReflectionBase commands are canceled when possible. ReflectionCommandGroup summerize cancelation progression
Version | Beta |
---|---|
Require User context | |
Authorization | |
Errors | NotExist |
Request
Route
Parameters
Parameter | Required | Sample | Description |
---|---|---|---|
ReflectionCommandGroupID | 14 | ID of ReflectionCommandGroup | |
WAC | WAC123456789012 | Code of BusinessAccount |
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/CancelReflectionCommandGroup HTTP/1.1
Host: localhost
Content-Type: application/json
Content-Length: length
{"wType":"CancelReflectionCommandGroup","reflectionCommandGroupID":0,"wac":"String"}
cURL command sample
curl -k -H "Authorization: Bearer [YOUR_ACCESS_TOKEN]" -H "Content-Type:application/json" -X DELETE -d @filename.json https://api.wit-datacenter.com/WAC123456789012/Reflection/CommandGroup/14
Remark
@filename.json
contain your request parameters serialized in JSON as described in Post Data sample bottom
Response
Returned Entity
Canceled ReflectionCommandGroupJSON Sample
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"wType":"ReflectionCommandGroup","commands":[{"wType":"ReflectionCommandGroupItem","reflectionID":0}],"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"}