CreateSavedTaskFilterRequest
Request model for creating a new saved task filter
Properties
| Name | Type | Description |
|---|---|---|
| name* | string | User-friendly name for this saved filter (e.g., "My Overdue Tasks", "Client ABC Tasks") |
User-friendly name for this saved filter (e.g., "My Overdue Tasks", "Client ABC Tasks") | ||
| description | string | Optional description providing more details about this filter's purpose |
Optional description providing more details about this filter's purpose | ||
| includeInMenu | boolean | Whether this filter should be included in the filter menu/quick access list |
Whether this filter should be included in the filter menu/quick access list | ||
| dateRange | enum | ThisWeek NextWeek Last7Days Next7Days Last30Days Next30Days PreviousMonth ThisMonth NextMonth PreviousQuarter ThisQuarter NextQuarter PreviousYear ThisYear NextYear YearToDate PreviousFinancialYear ThisFinancialYear NextFinancialYear FinancialYearToDate Today CustomDateRange |
ThisWeek NextWeek Last7Days Next7Days Last30Days Next30Days PreviousMonth ThisMonth NextMonth PreviousQuarter ThisQuarter NextQuarter PreviousYear ThisYear NextYear YearToDate PreviousFinancialYear ThisFinancialYear NextFinancialYear FinancialYearToDate Today CustomDateRange | ||
| startDate | string | Custom start date (only used when DateRange = CustomDateRange) |
Custom start date (only used when DateRange = CustomDateRange) | ||
| endDate | string | Custom end date (only used when DateRange = CustomDateRange) |
Custom end date (only used when DateRange = CustomDateRange) | ||
| dateBasis | enum | StartDate DueDate |
StartDate DueDate | ||
| clientCodes | array of string | Filter by client code(s) |
Filter by client code(s) | ||
| userCodes | array of string | Filter by user code(s) |
Filter by user code(s) | ||
| recurringTaskCodes | array of string | Filter by recurring task code(s) |
Filter by recurring task code(s) | ||
| categoryCodes | array of string | Filter by category code(s) |
Filter by category code(s) | ||
| teamCodes | array of string | Filter by team code(s) |
Filter by team code(s) | ||
| statuses | array of enum | Filter by task status(es) |
Filter by task status(es) | ||
| isOverdue | boolean | Filter to only overdue tasks |
Filter to only overdue tasks | ||
| isUnassigned | boolean | Include tasks with no assigned user. Can be combined with UserCodes to show |
Include tasks with no assigned user. Can be combined with UserCodes to show | ||
| includeProjected | boolean | Include projected (virtual) tasks in the results |
Include projected (virtual) tasks in the results | ||
| includeWorkflowSteps | boolean | Include workflow steps in the results (Agenda mode) |
Include workflow steps in the results (Agenda mode) | ||
| defaultSortField | enum | Name DueDate StartDate Category ClientName AssignedUser |
Name DueDate StartDate Category ClientName AssignedUser | ||
| defaultSortDesc | boolean | Sort in descending order (true) or ascending order (false) |
Sort in descending order (true) or ascending order (false) | ||
| iconName | string | Optional Lucide icon name for visual identification (e.g., "Calendar", "Users", "Star") |
Optional Lucide icon name for visual identification (e.g., "Calendar", "Users", "Star") | ||
| color | string | Optional hex color for visual identification (e.g., "#FF5733") |
Optional hex color for visual identification (e.g., "#FF5733") | ||
JSON Example
{
"name": "string",
"description": "string",
"includeInMenu": false,
"dateRange": "ThisWeek",
"startDate": "2024-01-01"
}