Tasks
Gets all the tasks in the given project.
Select
- Id supports '=' operator
- CreatedBy supports '=,!=,CONTAINS' operators
- Name supports '=,!=,CONTAINS' operators
- Priority supports '=,!=,CONTAINS' operators
- Description supports '=,!=,CONTAINS' operators
- IsCompleted supports '=,!=,CONTAINS' operators
- CompletionPercentage supports '=,!=,<,>,<=,>=,CONTAINS' operators
- ViewId supports '=' operator
- Columns that support server-side ORDER BY: Id, Name, StartDate, EndDate, CreatedBy, IsCompleted, CompletionPercentage, CreatedTime, LastModifiedTime
SELECT * FROM Tasks WHERE Id = '12345600000123'
Insert
Name field is required to create a task.
To create a new Task you can specify the following fields:
- Name
- Description
- BillingType
- CompletionPercentage
- DurationValue
- DurationType
- StartDate
- EndDate
- Priority
- StatusId
- TasklistId
- ParentTaskId
- Owners
- WorkType
- WorkUnit
- CopyTaskDuration
- Tags
- Teams
- BudgetInfoBudget
- BudgetInfoThreshold
- BudgetInfoRevenueBudget
- BudgetInfoCostRatePerHour
- BudgetInfoRatePerHour
- RecurrenceTriggerType
- ReminderCriteria
- ReminderTime
- Attachments
- ThirdpartyId
INSERT INTO Tasks (Name, Description, DurationValue, DurationType, Priority)
VALUES ('New Task #2', 'This is a test description', '5', 'hrs', 'High')
Update
To update a Task specify the Id field.
UPDATE Tasks SET Priority = 'Low' WHERE Id = '123456000000034003'
Delete
Tasks can be deleted by providing the Id and issuing a DELETE statement.
DELETE FROM Tasks WHERE Id = '123456000000034003'
Columns
| Name | Type | ReadOnly | Description |
| Id [KEY] | Long | True |
Unique identifier of the task. |
| Name | String | False |
Title of the task. |
| Prefix | String | True |
Prefix used for task numbering. |
| Description | String | False |
Description of the task. |
| Priority | String | False |
Priority level of the task. The allowed values are none, low, medium, high. |
| Color | String | False |
Color of the task. |
| BillingType | String | False |
Billing type for the task. The allowed values are none, billable, non_billable. |
| CompletionPercentage | Integer | False |
Progress of the task as a percentage (0-100). |
| IsCompleted | Boolean | True |
Indicates whether the task is marked as completed. |
| Depth | Integer | True |
Level of the task in the hierarchy. |
| CreatedVia | String | True |
Source of task creation. |
| StartDate | Datetime | False |
Scheduled start date/time in ISO 8601 format. |
| EndDate | Datetime | False |
Scheduled end date/time in ISO 8601 format. |
| DurationValue | Integer | False |
Duration value of the task. |
| DurationType | String | False |
Unit for the duration. The allowed values are days, hours. |
| Sequence | Integer | True |
Sequence number of the task in its list. |
| SubTaskSequence | Integer | True |
Sequence number of the sub task in its list. |
| CreatedTime | Datetime | True |
Timestamp of when the task was created. |
| LastModifiedTime | Datetime | True |
Timestamp of the most recent update. |
| StatusId | Long | False |
Identifier of the current task status. |
| StatusName | String | True |
Status label. |
| StatusColor | String | True |
Status color reference name. |
| StatusColorHexcode | String | True |
HEX color code for the status. |
| StatusIsClosedType | Boolean | True |
Indicates whether the status represents a closed state. |
| ProjectId | Long | True |
Identifier of the project. |
| ProjectName | String | True |
Name of the project. |
| MilestoneId | Long | True |
Identifier of the phase associated with the task. |
| MilestoneName | String | True |
Name of the phase. |
| TasklistId | Long | False |
Identifier of the task list containing the task. |
| TasklistName | String | True |
Name of the task list. |
| ParentTaskId | Long | False |
Identifier of the parent task. |
| RootTaskId | Long | True |
Identifier of the root task. |
| CreatedByZuid | Long | True |
Zoho user ID of the creator. |
| CreatedByZpuid | Long | True |
Portal-specific user ID of the creator. |
| CreatedByName | String | True |
Display name of the creator. |
| CreatedByEmail | String | True |
Email address of the creator. |
| CreatedByFirstName | String | True |
First name of the creator. |
| CreatedByLastName | String | True |
Last name of the creator. |
| UpdatedByZuid | Long | True |
Updated By Zuid. |
| UpdatedByZpuid | Long | True |
Updated By Zpuid. |
| UpdatedByName | String | True |
Updated By Name. |
| UpdatedByEmail | String | True |
Updated By Email. |
| UpdatedByFirstName | String | True |
Updated By First Name. |
| UpdatedByLastName | String | True |
Updated By Last Name. |
| Owners | String | False |
An array of direct owner objects (for task creation or retrieval) |
| WorkType | String | False |
Defines whether work is standard or flexible. |
| TotalWork | String | True |
Planned total work time for the task. |
| WorkUnit | String | False |
Unit of measurement for the work allocation. |
| CopyTaskDuration | Boolean | False |
Indicates whether the task duration is copied as work. |
| RefreshBusinessHours | Boolean | True |
Used to refresh business hours based on settings. |
| RecurrenceId | Long | True |
Identifier of the recurrence. |
| RecurrenceFrequency | String | True |
Frequency for recurring tasks. The allowed values are none, daily, weekly, monthly, yearly. |
| RecurrenceInterval | Integer | True |
Interval between the recurrence frequency. |
| RecurrenceEndAfterOccurrences | String | True |
Maximum number of occurrences allowed. |
| RecurrenceSetToPreviousBusinessday | Boolean | True |
Adjusts recurrences to the previous business day if needed. |
| RecurrenceRetainComments | Boolean | True |
Indicates whether comments are carried forward. |
| RecurrenceRetainSubtasks | Boolean | True |
Indicates whether subtasks are carried forward. |
| RecurrenceNextAfterClose | Boolean | True |
Indicates whether the next recurrence is scheduled after task close. |
| RecurrenceTriggerType | String | False |
Indicates when the next recurrence should be triggered. The allowed values are on_schedule, on_complete, first_to_occur. |
| RecurrenceRetainConfigComments | Boolean | False |
Indicates whether comments are retained in recurrence configuration. |
| RecurrenceRetainConfigBillingType | Boolean | False |
Indicates whether billing type is retained in recurrence configuration. |
| RecurrenceRetainConfigFollowers | Boolean | False |
Indicates whether followers are retained in recurrence configuration. |
| RecurrenceRetainConfigDescription | Boolean | False |
Indicates whether description is retained in recurrence configuration. |
| RecurrenceRetainConfigSubtasks | Boolean | False |
Indicates whether subtasks are retained in recurrence configuration. |
| RecurrenceRetainConfigTags | Boolean | False |
Indicates whether tags are retained in recurrence configuration. |
| RecurrenceRetainConfigAttachments | Boolean | False |
Indicates whether attachments are retained in recurrence configuration. |
| RecurrenceRetainConfigTeams | Boolean | False |
Indicates whether teams are retained in recurrence configuration. |
| RecurrenceDateBasedName | String | False |
Name identifier of the date-based recurrence schedule. |
| RecurrenceDateBasedRepetativeType | String | False |
Repetition type for the date-based recurrence. |
| RecurrenceDateBasedScheduleDatetime | Datetime | True |
Scheduled date and time for the date-based recurrence. |
| RecurrenceDateBasedTimeSpan | Integer | False |
Time span interval for the date-based recurrence. |
| RecurrenceDateBasedEndsAfterType | String | False |
Type of end condition for the date-based recurrence. |
| RecurrenceDateBasedEndsAfterValue | String | False |
Value for the end condition of the date-based recurrence. |
| RecurrenceDateBasedSkipType | String | False |
Skip type when recurrence falls on a non-business day. |
| RecurrenceDateBasedStatus | String | True |
Status of the date-based recurrence schedule. |
| RecurrenceDateBasedTime | String | True |
Time of day for the date-based recurrence. |
| RecurrenceDateBasedId | Long | True |
Identifier of the date-based recurrence. |
| RecurrenceDateBasedSchedulerId | Long | True |
Identifier of the scheduler for the date-based recurrence. |
| RecurrenceDateBasedLastScheduleTime | Datetime | True |
Timestamp of the last scheduled recurrence. |
| RecurrenceDateBasedNextScheduleTime | Datetime | True |
Timestamp of the next scheduled recurrence. |
| RecurrenceDateBasedNoOfTimesExecuted | Integer | True |
Number of times the recurrence has been executed. |
| RecurrenceDateBasedExecutedCount | Integer | True |
Count of executed recurrence instances. |
| RecurrenceDateBasedIsCompleted | Boolean | True |
Indicates whether the date-based recurrence is completed. |
| RecurrenceDateBasedFieldName | String | True |
Field name used for the date-based recurrence trigger. |
| RecurrenceDateBasedDaysOfWeek | String | True |
Days of the week for the date-based recurrence. |
| ReminderNotifyUsers | String | True |
List of users or teams notified by the task reminder. |
| ReminderCriteria | String | False |
Criteria for setting the task reminder. The allowed values are none, daily, on, before, after. |
| ReminderTaskReminderId | Long | True |
Unique identifier of the task reminder. |
| ReminderTime | String | False |
Time for sending the task reminder. |
| ReminderNextRuntime | String | True |
Next scheduled time for the task reminder. |
| BudgetInfoBudget | String | False |
Budget allocated for the task. |
| BudgetInfoThreshold | String | False |
Budget threshold for warnings. |
| BudgetInfoCurrencyCode | String | True |
Currency used for budgeting. |
| BudgetInfoHourlyBudget | String | False |
Hourly budget of the task. |
| BudgetInfoHourlyBudgetThreshold | String | False |
Threshold for hourly budget warnings. |
| BudgetInfoRevenueBudget | Double | False |
Revenue target for the task. |
| BudgetInfoCostRatePerHour | Double | False |
Internal cost per hour. |
| BudgetInfoRatePerHour | Double | False |
Billable rate per hour. |
| CostBudgetPlannedCost | Double | True |
Planned cost of the task. |
| CostBudgetActualCost | Double | True |
Actual cost of the task. |
| CostBudgetForecastedCost | Double | True |
Predicted cost to completion. |
| CostBudgetBalance | Double | True |
Remaining cost budget. |
| HourlyBudgetActualHours | String | True |
Logged actual hours. |
| HourlyBudgetPlannedHours | String | True |
Planned hours. |
| HourlyBudgetDifference | String | True |
Difference between actual and planned hours. |
| HourlyBudgetForecastedHours | String | True |
Forecasted hours. |
| RevenueBudgetPlannedRevenue | Double | True |
Planned revenue for the task. |
| RevenueBudgetActualRevenue | Double | True |
Actual revenue for the task. |
| RevenueBudgetForecastedRevenue | Double | True |
Predicted revenue to completion. |
| LogHoursBillableHours | String | True |
Hours logged as billable. |
| LogHoursNonBillableHours | String | True |
Hours logged as non-billable. |
| LogHoursTotalHours | String | True |
Total hours logged. |
| HasReminder | Boolean | True |
Indicates whether the task has a reminder. |
| HasRecurrence | Boolean | True |
Indicates whether the task has a recurrence. |
| HasComments | Boolean | True |
Indicates whether the task has comments. |
| HasAttachments | Boolean | True |
Indicates whether the task has attachments. |
| HasForums | Boolean | True |
Indicates whether the task has associated forums. |
| HasSubtasks | Boolean | True |
Indicates whether the task has subtasks. |
| HasBugs | Boolean | True |
Indicates whether the task has bugs. |
| HasParents | Boolean | True |
Indicates whether the task has parents. |
| Tags | String | False |
List of tags associated with the task. |
| Teams | String | False |
List of teams associated with the task. |
| ViewId | Long | True |
Identifier of a custom view to filter tasks. |
Pseudocolumns
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description |
| Attachments | String |
Array of the IDs of the files to attach to the task. |
| ThirdpartyId | String |
Array of the WorkDrive resource IDs of the files to associate. |