| Name | Description | Type | Additional information |
|---|---|---|---|
| ID |
The ProgramGroup's unique ID |
integer |
None. |
| Name |
Name of the ProgramGroup |
string |
None. |
| Description |
Description of the ProgramGroup |
string |
None. |
| ParentGroupID |
Unique ID of this ProgramGroup's Parent, if applicable |
integer |
None. |
| DisplayIndex |
Index used for displaying the ProgramGroup, used for displaying them in a specific order |
integer |
None. |
| Offset |
Specifies the Offset to use for generating this ProgramGroup's timing |
time interval |
None. |
| StartDate |
The calculated StartDate for the ProgramGroup, dependent on the Offset and the items that are within it |
date |
None. |
| FinishDate |
The calculated Finish for the ProgramGroup, dependent on the Offset and the items that are within it |
date |
None. |
| LinkID |
The unique ID of the item that this ProgramGroup is linked to, if applicable. It can be linked to either a ProgramGroup or a ProgramStep, as defined by LinkObjectType |
integer |
None. |
| LinkObjectType |
Defines the type of item this ProgramGroup is linked to via LinkID |
LinkObjectType |
None. |
| LinkType |
Defines how this ProgramGroup is linked to the item specified by LinkID |
LinkType |
None. |
| TotalTime |
The Total Time that this ProgramGroup will run for, not including Offset. i.e. this is dependent on the children of this ProgramGroup. |
time interval |
None. |
| ProgramSteps |
Array of ProgramStep that this ProgramGroup contains |
Collection of ProgramStep |
None. |