| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
unique id of this category |
integer32 |
None. |
| Index |
The ordering of categories within a profile. Lowest index number will be evaluated first. |
integer32 |
None. |
| Name | string |
Required String length: inclusive between 1 and 255 |
|
| ColorHex | string |
Required Matching regular expression pattern: ^#([A-Fa-f0-9]{6})$ |
|
| UsesDuration |
indicates if Duration is used for this category |
boolean |
None. |
| FromSecondsInclusive |
if using duration, this is minimum activity length |
integer32 |
Null values possible. Range: inclusive between 0 and 2147483647 |
| ToSecondsInclusive |
if using duration, this is maximum activity length |
integer32 |
Null values possible. Range: inclusive between 0 and 2147483647 |
| UsesPeriod |
indicates if weekly period is used for this category |
boolean |
None. |
| StartDayOfWeek |
if using weekly period, this is the day of week that the period start |
DayOfWeekEnum |
Null values possible. |
| StartTimeOfDayMinutes |
if using weekly period, The minutes into period start day of week |
integer32 |
Null values possible. Range: inclusive between 0 and 1439 |
| EndDayOfWeek |
if using weekly period, this is the day of week that the period ends, implicitly always being the first following day of week after start |
DayOfWeekEnum |
Null values possible. |
| EndTimeOfDayMinutes |
The minutes into the period end day of week |
integer32 |
Null values possible. Range: inclusive between 0 and 1439 |
| TimeZone |
if using weekly period, this is the selected timezone of the category weekly period. |
TimeZoneModel |
None. |