| Name | Description | Type | Additional information |
|---|---|---|---|
| ID |
The goal's ID |
globally unique identifier |
None. |
| Name |
The goal's name/title |
string |
None. |
| Description |
The goal's description |
string |
None. |
| GoalType |
The goal's type/category: WIG = 0, SubWIG = 1, Lead = 2 |
byte |
None. |
| DisplayType |
The goal's value storage type: Number = 5, Money = 9, Percentage = 17 |
byte |
None. |
| DisplayColor |
The goal's current state color: Red = 255, Yellow = 0, Green = 1 |
byte |
None. |
| BoundaryType |
The goal's boundary condition type: Meet or Exceeds = 0, Not Greater Than = 1 |
byte |
None. |
| CurrentValue |
The goal's current value |
decimal number |
None. |
| TargetValue |
The current target value for this goal with respect to the current UTC date and goal waypoints. |
decimal number |
None. |
| DisplayValue |
The goal's display value. This could be different than the current value if it is an aggregate or composite goal. |
decimal number |
None. |
| StartValue |
The value of the starting waypoint |
decimal number |
None. |
| EndValue |
The value of the ending waypoint |
decimal number |
None. |
| CurrentDecimalLength |
The decimal precision required when displaying the display or current value. This is NOT applied to the data value coming down from the server. |
integer |
None. |
| TargetDecimalLength |
The decimal precision required when displaying the target value. This is NOT applied to the data value coming down from the server. |
integer |
None. |
| FinalDecimalLength |
The decimal precision required when displaying the final value. This is NOT applied to the data value coming down from the server. |
integer |
None. |
| TeamID |
The goal's team ID |
globally unique identifier |
None. |
| YellowTolerance |
Yellow tolerance/variance value |
decimal number |
None. |
| RedTolerance |
Red tolerance/variance value |
decimal number |
None. |
| WaypointType |
Linear = 0, Step = 1, Periodstep = 2, Weekly Reset Daily Step = 3 |
integer |
None. |
| InTeamChildrenIDs |
IN team goal child IDs |
Collection of globally unique identifier |
None. |
| InTeamParentIDs |
IN team goal parent IDs |
Collection of globally unique identifier |
None. |
| OutTeamChildrenIDs |
OUT of team goal child IDs |
Collection of globally unique identifier |
None. |
| OutTeamParentIDs |
OUT of team goal parent IDs |
Collection of globally unique identifier |
None. |
| IsRetired |
If the goal is retired |
boolean |
None. |
| IsDeleted |
If the goal is deleted |
boolean |
None. |
| IsFuture |
If the goal isn't active yet (future goal) |
boolean |
None. |