CommandReflectionTemplate Documentation
SDK DotNet
SDK Android
SDK IOS
AccountBase
Address
App
AppRequest
Authorization
Building
BusinessAccount
Country
Culture
Data
DataContainer
DataRequestOrder
ExtendedProperty
ExtendedPropertyValue
FileLTU
FileLTUContainer
FileLTURequestOrder
FileStore
Flux
FluxContainer
FluxRequestOrder
InfrastructureBase
InfrastructureShortBase
IRequestOrderBase
LTU
LTUBase
LTUContainer
LTUeWon
Message
Organization
Point
PointGroup
Preparation
QuickStart
ReflectionAnalogic
ReflectionBase
ReflectionCommandAnalogic
ReflectionCommandBase
ReflectionCommandDigital
ReflectionCommandDuret
ReflectionCommandEwon
ReflectionCommandGroup
ReflectionCommandGroupContainer
ReflectionCommandGroupExecutionSummary
ReflectionCommandGroupItem
ReflectionCommandGroupPhaseSummary
ReflectionCommandMultiple
ReflectionCommandPlanning
ReflectionCommandState
ReflectionCommandSystem
ReflectionCommandText
ReflectionCommandUnitOfProd
ReflectionContainer
ReflectionDataAnalogic
ReflectionDataBase
ReflectionDataContainer
ReflectionDataDigital
ReflectionDataDuret
ReflectionDataEwon
ReflectionDataPlanning
ReflectionDataState
ReflectionDataSystem
ReflectionDataText
ReflectionDataUnitOfProd
ReflectionDigital
ReflectionEvent
ReflectionEwon
ReflectionFormat
ReflectionGeneric
ReflectionItemAnalogic
ReflectionItemBase
ReflectionItemDigital
ReflectionItemList
ReflectionItemText
ReflectionParameterAnalogic
ReflectionPlanning
ReflectionRequestOrder
ReflectionState
ReflectionStateReference
ReflectionSystem
ReflectionTemplate
ReflectionText
ReflectionUnitOfProd
Role
RoleStatus
Site
User
ValueAnalogic
ValueBase
ValueDigital
ValueText
WAC
WBase
WCAExceptionResource
WDCParameter
WDCService
WEvent
WEventCategory
WEventItem
WEventsContainer
WEventsRequestOrder
WEventType
WUM
WUMFunction
WUMMaterial
WUMType
WUMUnit
WUMUnitCategory
WUMUnitFamily
WUMUnitItem
Zone
AppMyKindEnum
AppTypeEnum
AppUsageEnum
CommunicationMediaEnum
CommunicationTypeEnum
EntityStatusEnum
ErrorCodeEnum
FileLTUKindEnum
FileSizeEnum
FluxLevelEnum
ImageTypeEnum
LTUTypeEnum
OperationEnum
OrganizationStatusEnum
OrganizationTypeEnum
PreparationTypeEnum
ReflectionClassEnum
ReflectionCommandGroupExecutionEnum
ReflectionCommandGroupPhaseEnum
ReflectionDirectionEnum
ReflectionEwonCodeEnum
ReflectionEwonScenarioEnum
ReflectionExecutionStatusEnum
ReflectionFormatKindEnum
ReflectionPhaseEnum
ReflectionStateEnum
ReflectionSystemCodeEnum
ReflectionSystemOptionEnum
ReflectionSystemScenarioEnum
TrackingEnum
UserHonorificTitleEnum
UserStatusEnum
ValueTypeEnum
WAppEnum
WDCAppTypeEnum
WEntityTypeEnum
WEventCategoryEnum
WEventItemRoleEnum
WEventItemTypeEnum
WEventModeEnum
WProcessTemplateModeEnum
WUMTypeEnum
CommandReflectionTemplate
Draft documentation version
Documentation is partial and not validated !
Description
| Version | Alpha |
|---|---|
| Require User context | |
| Authorization | |
| Errors |
Request
Route
Parameters
| Parameter | Required | Sample | Description |
|---|---|---|---|
| TemplateID | 2 | ID of ReflectionTemplate | |
| WAC | WAC123456789012 | Code of BusinessAccount | |
| ExecutionDate | 2014-09-15T13:59:20.0000000Z | Execution planned date. If empty, command is executed on next LTU call | |
| ReflectionIDs | 1,2,3 | ID of ReflectionBase | |
| ThrowMissingMapping | true | Used when some ReflectionBase are not configured for TemplateID. In this case, if true throw an error else ignore not configured | |
| Tracking | Main | Ack and execution command tracking level as TrackingEnum |
Remarks
- To override Content-type in your clients HTTP Accept Header, append the
.jsvsuffix or?format=jsv - To embed the response in a jsonp callback, append
?callback=myCallback
Post Data sample
POST /jsv/reply/CommandReflectionTemplate HTTP/1.1
Host: localhost
Content-Type: text/jsv
Content-Length: length
{
wType: CommandReflectionTemplate,
reflectionIDs:
[
0
],
templateID: 0,
executionDate: 0001-01-01,
throwMissingMapping: False,
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/CommandTemplate/2
Remark
@filename.jsv contain your request parameters serialized in JSV as described in Post Data sample bottom
Response
Returned Entity
Commands as 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
}