| Name | Description | Type | Additional information |
|---|---|---|---|
| ID |
ID for the ProgramStep, if updating a ProgramStep |
integer |
None. |
| GroupID |
ID of the ProgramGroup this ProgramStep resides within |
integer |
None. |
| Description |
Description of the ProgramStep |
string |
None. |
| ProgramStepType |
The type of ProgramStep this is for, i.e. Duration, Independent, Dependent |
ProgramStepType |
None. |
| DisplayIndex |
The Index used for displaying this ProgramStep |
integer |
None. |
| LinkID |
ID of the object that we're linking to, which could be a ProgramGroup or ProgramStep |
integer |
None. |
| LinkObjectType |
The type of the object we're linking to,m either a ProgramGroup or ProgramStep |
LinkObjectType |
None. |
| LinkType |
The methodology for linking this ProgramStep to the object indicated by LinkID |
LinkType |
None. |
| DeviceID |
The ID of the Device this ProgramStep is utilising |
integer |
None. |
| SetValue |
The value to set the Device to when running |
decimal number |
None. |
| ReturnValue |
The value to return the Device to when finished |
decimal number |
None. |
| StartDate |
The calculated Start Date for the ProgramStep, as provided to the API |
date |
None. |
| FinishDate |
The calculated Finish Date for the ProgramStep, as provided to the API |
date |
None. |
| StartOffset |
Start Offset for a ProgramStep, required for ProgramSteps of the Duration type |
time interval |
None. |
| FinishOffset |
Finish Offset for a ProgramStep, required for ProgramSteps of the Duration type |
time interval |
None. |
| Offset |
Offset for a ProgramStep, used to determine the DelayFromStart. Required for all ProgramSteps other than Duration as Duration only has Start/Finish Offsets. |
time interval |
None. |
| Duration |
TimeSpan for a ProgramStep, used to determine the TimeToRun. Required for all ProgramSteps other than Duration as Duration only has Start/Finish Offsets. |
time interval |
None. |
| LinkedDeviceID |
ID of the linked device that is linked to this ProgramStep, that will provide an automatic cut-off if the input LinkCutoffValue is reached |
integer |
None. |
| LinkCutoffValue |
The value that the ProgramStep will automatically cut off on, if a linked device is specified |
decimal number |
None. |
| BatchTotalised |
Whether or not the linked Schedule is batch totalised |
boolean |
None. |