ArchiveReflectionCommandGroup Documentation
ArchiveReflectionCommandGroup
Draft documentation version
Documentation is partial and not validated !
Description
Remark
You can also restore archived ReflectionCommandGroup
Version | V1 |
---|---|
Require User context | |
Authorization | |
Errors |
Request
Route
Parameters
Parameter | Required | Sample | Description |
---|---|---|---|
Archive | true | Archive: true to archive else false | |
ReflectionCommandGroupID | 6 | ID of ReflectionCommandGroup | |
WAC | WAC123456789012 | Code of BusinessAccount |
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/ArchiveReflectionCommandGroup HTTP/1.1
Host: localhost
Content-Type: text/jsv
Content-Length: length
{
wType: ArchiveReflectionCommandGroup,
reflectionCommandGroupID: 0,
archive: False,
wac: String
}
cURL command sample
curl -k -H "Authorization: Bearer [YOUR_ACCESS_TOKEN]" -H "Content-Type:application/jsv" -X PATCH -d @filename.jsv https://api.wit-datacenter.com/WAC123456789012/Reflection/CommandGroup/6/Archive/true
Remark
@filename.jsv
contain your request parameters serialized in JSV as described in Post Data sample bottom
Response
Returned Entity
Archived Compact ReflectionCommandGroupJSV Sample
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { wType: ReflectionCommandGroupShort, description: String, phase: New, execution: 0, creationDate: 0001-01-01, updateDate: 0001-01-01, planningDate: 0001-01-01, 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 }