Update a task.
id
globally unique identifier
Required
Guid ID of the Task to be updated. |
tz
string
Optional parameter to set time zone information. |
This object takes all the parameters needed to update an task.
System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList
ID
globally unique identifier
Required on Update
ID of the Task. |
AncestorID
globally unique identifier
Required on Create
ID of the ancestor for a task; department, organization, or individual. |
ParentID
globally unique identifier
ID of the project above a task. |
Name
string
Required
Name of the task. (Max length 255 characters) |
Description
string
Description of the task. |
Priority
integer
Priority of the task. Valid inputs are: 1= low, 2 = normal, 3 = high, or null. |
Rank
integer
Rank of the task. |
Color
string
Hex value for the color of the given task. |
HoursActual
decimal number
Number of actual hours this task took. |
HoursProjected
decimal number
Number of hours this task is projected to take. |
StartDateActual
string
Date this task was actually started. |
StartDateProjected
string
Date this task is projected to start. |
EndDateActual
string
Date this task was completed. |
EndDateProjected
string
Date this task is projected to complete. |
Milestone
boolean
Displays if this task is a milestone or not. |
TrackingLabel
string
Customizable label for task. (Max length 50 characters) |
NearHighlightOverride
integer
Override the near due date highlights settings for a specific task. |
SiteID
globally unique identifier
ReadOnly
ID of the site for the task. |
RankPath
Collection of byte
ReadOnly
Current rank of the given task in a byte array. |
RankOrder
string
ReadOnly
RankOrder to sort rank in the format .0001.0001.0001 (This always returns null when reading a single task by ID.) |
DisplayRank
string
ReadOnly
Rank that is displayed |
Level
integer
ReadOnly
Number of indent levels, Ex: 1 = 1, 1.1 = 2, 1.1.1 = 3 (This always returns null when reading a single task by ID.) |
SumHoursActual
decimal number
ReadOnly
Sum of the actual number of hours this task took. |
SumHoursProjected
decimal number
ReadOnly
Sum of the number of hours this task is projected to take. |
Deleted
boolean
ReadOnly
Deleted status of the task. |
DeletedByRef
boolean
ReadOnly
Deleted by reference status of the task. |
Created
date
ReadOnly
Date the task was created. |
CreatedBy
globally unique identifier
ReadOnly
ID of the person that created the task. |
Updated
date
ReadOnly
Date when the task was last updated. |
UpdatedBy
globally unique identifier
ReadOnly
ID of the person that updated the task. |
PeopleResponsible
string
ReadOnly
Names of the People responsible for this task. |
PeopleResponsibleList
Collection of PersonResponsible
ReadOnly
List and details of all the people responsible for the given task. |
LastComment
string
ReadOnly
Body of the most recent comment for the given task. |
LastCommentDate
date
ReadOnly
Date of the most recent comment for the given task. |
LastCommentByID
globally unique identifier
ReadOnly
ID of the individual who posted the most recent comment for the given task. |
LastCommentBy
string
ReadOnly
Name of the individual who posted the most recent comment for the given task. |
Draft
boolean
ReadOnly
Displays if this task is a draft or not. |
RowType
integer
ReadOnly
Row type of the task. |
AncestorType
byte
ReadOnly
Row type of the Ancestor. |
AncestorName
string
ReadOnly
Name of the task's Ancestor. |
ColorName
string
ReadOnly
Name of the task's color. |
ColorRank
integer
ReadOnly
Rank of the task's color. |
EndDate
string
ReadOnly
Date the task actually ended or projected to end. |
StartDate
string
ReadOnly
Date the task actually started or projected to start. |
NearHighlight
integer
ReadOnly
Near due date highlights settings for a specific task. |
CanRead
boolean
ReadOnly
Read security setting for the object based on the current logged in user. |
CanUpdate
boolean
ReadOnly
Update security setting for the object based on the current logged in user. |
CanDelete
boolean
ReadOnly
Delete security setting for the object based on the current logged in user. |
CanDelegate
boolean
ReadOnly
Delegate security setting for the object based on the current logged in user. |
IsRecurring
boolean
This denotes if the task will reoccur when it is completed. |
Interval
integer
Interval of the recurring task. |
IntervalQualifier
string
Interval type for the task. This can be: Day, Month, Week, or Year |
MonthOption
boolean
If it is monthly ex 2nd tuesday |
DayOfMonth
byte
Sets day of the month the task should reoccur |
WeekDayInstance
byte
1-5 Tuesday |
WeekDay
byte
Day of the week. |
Sunday
boolean
Denotes if this task should repeat on Sunday. |
Monday
boolean
Denotes if this task should repeat on Monday. |
Tuesday
boolean
Denotes if this task should repeat on Tuesday. |
Wednesday
boolean
Denotes if this task should repeat on Wednesday. |
Thursday
boolean
Denotes if this task should repeat on Thursday. |
Friday
boolean
Denotes if this task should repeat on Friday. |
Saturday
boolean
Denotes if this task should repeat on Saturday. |
PreviousTask
globally unique identifier
ReadOnly
ID of the previous task. |
NextTask
globally unique identifier
ReadOnly
ID of the next task. Recurrence can no longer be set if this is not null. |
NewPeople
string
List of comma separated GUID Individual IDs to add to a new task. |
<Task xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4"> <ID>eeb270e6-41f7-4018-9686-8f9d038f9f0c</ID> <AncestorID>943bd94c-615d-40f6-bcae-54df21c0a518</AncestorID> <ParentID>a6c011c8-c6de-4ff6-a4f2-f5d7a9b43c44</ParentID> <Name>sample string 1</Name> <Description>sample string 2</Description> <Priority>1</Priority> <Rank>1</Rank> <Color>sample string 3</Color> <HoursActual>1</HoursActual> <HoursProjected>1</HoursProjected> <Milestone>true</Milestone> <TrackingLabel>sample string 8</TrackingLabel> <NearHighlightOverride>1</NearHighlightOverride> <IsRecurring>true</IsRecurring> <Interval>1</Interval> <IntervalQualifier>sample string 19</IntervalQualifier> <MonthOption>true</MonthOption> <DayOfMonth>64</DayOfMonth> <WeekDayInstance>64</WeekDayInstance> <WeekDay>64</WeekDay> <Sunday>true</Sunday> <Monday>true</Monday> <Tuesday>true</Tuesday> <Wednesday>true</Wednesday> <Thursday>true</Thursday> <Friday>true</Friday> <Saturday>true</Saturday> <NewPeople>sample string 27</NewPeople> </Task>
{ "ID": "eeb270e6-41f7-4018-9686-8f9d038f9f0c", "AncestorID": "943bd94c-615d-40f6-bcae-54df21c0a518", "ParentID": "a6c011c8-c6de-4ff6-a4f2-f5d7a9b43c44", "Name": "sample string 1", "Description": "sample string 2", "Priority": 1, "Rank": 1, "Color": "sample string 3", "HoursActual": 1.0, "HoursProjected": 1.0, "Milestone": true, "TrackingLabel": "sample string 8", "NearHighlightOverride": 1, "IsRecurring": true, "Interval": 1, "IntervalQualifier": "sample string 19", "MonthOption": true, "DayOfMonth": 64, "WeekDayInstance": 64, "WeekDay": 64, "Sunday": true, "Monday": true, "Tuesday": true, "Wednesday": true, "Thursday": true, "Friday": true, "Saturday": true, "NewPeople": "sample string 27" }
ID
globally unique identifier
Required on Update
ID of the Task. |
AncestorID
globally unique identifier
Required on Create
ID of the ancestor for a task; department, organization, or individual. |
ParentID
globally unique identifier
ID of the project above a task. |
Name
string
Required
Name of the task. (Max length 255 characters) |
Description
string
Description of the task. |
Priority
integer
Priority of the task. Valid inputs are: 1= low, 2 = normal, 3 = high, or null. |
Rank
integer
Rank of the task. |
Color
string
Hex value for the color of the given task. |
HoursActual
decimal number
Number of actual hours this task took. |
HoursProjected
decimal number
Number of hours this task is projected to take. |
StartDateActual
string
Date this task was actually started. |
StartDateProjected
string
Date this task is projected to start. |
EndDateActual
string
Date this task was completed. |
EndDateProjected
string
Date this task is projected to complete. |
Milestone
boolean
Displays if this task is a milestone or not. |
TrackingLabel
string
Customizable label for task. (Max length 50 characters) |
NearHighlightOverride
integer
Override the near due date highlights settings for a specific task. |
SiteID
globally unique identifier
ReadOnly
ID of the site for the task. |
RankPath
Collection of byte
ReadOnly
Current rank of the given task in a byte array. |
RankOrder
string
ReadOnly
RankOrder to sort rank in the format .0001.0001.0001 (This always returns null when reading a single task by ID.) |
DisplayRank
string
ReadOnly
Rank that is displayed |
Level
integer
ReadOnly
Number of indent levels, Ex: 1 = 1, 1.1 = 2, 1.1.1 = 3 (This always returns null when reading a single task by ID.) |
SumHoursActual
decimal number
ReadOnly
Sum of the actual number of hours this task took. |
SumHoursProjected
decimal number
ReadOnly
Sum of the number of hours this task is projected to take. |
Deleted
boolean
ReadOnly
Deleted status of the task. |
DeletedByRef
boolean
ReadOnly
Deleted by reference status of the task. |
Created
date
ReadOnly
Date the task was created. |
CreatedBy
globally unique identifier
ReadOnly
ID of the person that created the task. |
Updated
date
ReadOnly
Date when the task was last updated. |
UpdatedBy
globally unique identifier
ReadOnly
ID of the person that updated the task. |
PeopleResponsible
string
ReadOnly
Names of the People responsible for this task. |
PeopleResponsibleList
Collection of PersonResponsible
ReadOnly
List and details of all the people responsible for the given task. |
LastComment
string
ReadOnly
Body of the most recent comment for the given task. |
LastCommentDate
date
ReadOnly
Date of the most recent comment for the given task. |
LastCommentByID
globally unique identifier
ReadOnly
ID of the individual who posted the most recent comment for the given task. |
LastCommentBy
string
ReadOnly
Name of the individual who posted the most recent comment for the given task. |
Draft
boolean
ReadOnly
Displays if this task is a draft or not. |
RowType
integer
ReadOnly
Row type of the task. |
AncestorType
byte
ReadOnly
Row type of the Ancestor. |
AncestorName
string
ReadOnly
Name of the task's Ancestor. |
ColorName
string
ReadOnly
Name of the task's color. |
ColorRank
integer
ReadOnly
Rank of the task's color. |
EndDate
string
ReadOnly
Date the task actually ended or projected to end. |
StartDate
string
ReadOnly
Date the task actually started or projected to start. |
NearHighlight
integer
ReadOnly
Near due date highlights settings for a specific task. |
CanRead
boolean
ReadOnly
Read security setting for the object based on the current logged in user. |
CanUpdate
boolean
ReadOnly
Update security setting for the object based on the current logged in user. |
CanDelete
boolean
ReadOnly
Delete security setting for the object based on the current logged in user. |
CanDelegate
boolean
ReadOnly
Delegate security setting for the object based on the current logged in user. |
IsRecurring
boolean
This denotes if the task will reoccur when it is completed. |
Interval
integer
Interval of the recurring task. |
IntervalQualifier
string
Interval type for the task. This can be: Day, Month, Week, or Year |
MonthOption
boolean
If it is monthly ex 2nd tuesday |
DayOfMonth
byte
Sets day of the month the task should reoccur |
WeekDayInstance
byte
1-5 Tuesday |
WeekDay
byte
Day of the week. |
Sunday
boolean
Denotes if this task should repeat on Sunday. |
Monday
boolean
Denotes if this task should repeat on Monday. |
Tuesday
boolean
Denotes if this task should repeat on Tuesday. |
Wednesday
boolean
Denotes if this task should repeat on Wednesday. |
Thursday
boolean
Denotes if this task should repeat on Thursday. |
Friday
boolean
Denotes if this task should repeat on Friday. |
Saturday
boolean
Denotes if this task should repeat on Saturday. |
PreviousTask
globally unique identifier
ReadOnly
ID of the previous task. |
NextTask
globally unique identifier
ReadOnly
ID of the next task. Recurrence can no longer be set if this is not null. |
NewPeople
string
List of comma separated GUID Individual IDs to add to a new task. |
<Task xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4"> <ID>bbc3c3e5-8d01-46aa-98e4-79bde52e1480</ID> <AncestorID>0d493aa4-baec-42f6-b473-5d2c81704487</AncestorID> <ParentID>d982fe2f-20fa-4b34-8fd4-cebd2cd61950</ParentID> <Name>sample string 1</Name> <Description>sample string 2</Description> <Priority>1</Priority> <Rank>1</Rank> <Color>sample string 3</Color> <HoursActual>1</HoursActual> <HoursProjected>1</HoursProjected> <Milestone>true</Milestone> <TrackingLabel>sample string 8</TrackingLabel> <NearHighlightOverride>1</NearHighlightOverride> <SiteID>711b893a-399e-4bef-9753-01088f7d66a9</SiteID> <RankPath>QEA=</RankPath> <RankOrder>sample string 9</RankOrder> <DisplayRank>sample string 10</DisplayRank> <Level>1</Level> <SumHoursActual>1</SumHoursActual> <SumHoursProjected>1</SumHoursProjected> <Deleted>true</Deleted> <DeletedByRef>true</DeletedByRef> <Created>2025-03-08T05:47:00.1166413+00:00</Created> <CreatedBy>6dc7ad4d-d591-47fc-8bb2-1e7b7fb041ed</CreatedBy> <Updated>2025-03-08T05:47:00.1166413+00:00</Updated> <UpdatedBy>48bbdf9d-b28e-4ab5-8078-47bef747b6bf</UpdatedBy> <PeopleResponsible>sample string 11</PeopleResponsible> <PeopleResponsibleList> <PersonResponsible> <TaskID>228d6188-7425-4304-913e-40e34995c4e0</TaskID> <IndividualID>26e1f87a-0c88-408d-8912-22c0557f6fb5</IndividualID> <HoursProjected>1</HoursProjected> <HoursActual>1</HoursActual> <ID>f08d579d-eea5-4c21-a10d-8eb5672b28c9</ID> <TaskIndividualGroupID>5469eef5-308e-4a31-a0e2-89b55fa2bdee</TaskIndividualGroupID> <Created>2025-03-08T05:47:00.1166413+00:00</Created> <CreatedBy>fa4be17b-458c-41c4-a0c3-0009f231d8ee</CreatedBy> <SiteID>922fe0d8-e5b7-480d-b65e-4c76040a1d48</SiteID> <Updated>2025-03-08T05:47:00.1166413+00:00</Updated> <UpdatedBy>b3702608-161d-45f3-9e14-c73e28f233b5</UpdatedBy> <HoursActualRollup>1</HoursActualRollup> <HoursProjectedRollup>1</HoursProjectedRollup> <FullName>sample string 1</FullName> </PersonResponsible> <PersonResponsible> <TaskID>228d6188-7425-4304-913e-40e34995c4e0</TaskID> <IndividualID>26e1f87a-0c88-408d-8912-22c0557f6fb5</IndividualID> <HoursProjected>1</HoursProjected> <HoursActual>1</HoursActual> <ID>f08d579d-eea5-4c21-a10d-8eb5672b28c9</ID> <TaskIndividualGroupID>5469eef5-308e-4a31-a0e2-89b55fa2bdee</TaskIndividualGroupID> <Created>2025-03-08T05:47:00.1166413+00:00</Created> <CreatedBy>fa4be17b-458c-41c4-a0c3-0009f231d8ee</CreatedBy> <SiteID>922fe0d8-e5b7-480d-b65e-4c76040a1d48</SiteID> <Updated>2025-03-08T05:47:00.1166413+00:00</Updated> <UpdatedBy>b3702608-161d-45f3-9e14-c73e28f233b5</UpdatedBy> <HoursActualRollup>1</HoursActualRollup> <HoursProjectedRollup>1</HoursProjectedRollup> <FullName>sample string 1</FullName> </PersonResponsible> </PeopleResponsibleList> <LastComment>sample string 12</LastComment> <LastCommentDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System"> <d2p1:DateTime>2025-03-08T05:47:00.1166413Z</d2p1:DateTime> <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes> </LastCommentDate> <LastCommentByID>051569a1-c5b6-4255-9b7f-c9dd6c3e5f7d</LastCommentByID> <LastCommentBy>sample string 13</LastCommentBy> <Draft>true</Draft> <RowType>1</RowType> <AncestorType>64</AncestorType> <AncestorName>sample string 14</AncestorName> <ColorName>sample string 15</ColorName> <ColorRank>1</ColorRank> <NearHighlight>1</NearHighlight> <CanRead>true</CanRead> <CanUpdate>true</CanUpdate> <CanDelete>true</CanDelete> <CanDelegate>true</CanDelegate> <IsRecurring>true</IsRecurring> <Interval>1</Interval> <IntervalQualifier>sample string 19</IntervalQualifier> <MonthOption>true</MonthOption> <DayOfMonth>64</DayOfMonth> <WeekDayInstance>64</WeekDayInstance> <WeekDay>64</WeekDay> <Sunday>true</Sunday> <Monday>true</Monday> <Tuesday>true</Tuesday> <Wednesday>true</Wednesday> <Thursday>true</Thursday> <Friday>true</Friday> <Saturday>true</Saturday> <PreviousTask>8b1919ca-ae67-4f85-9d8e-c1eb181c7692</PreviousTask> <NextTask>4f3087fe-6af3-439e-8983-520325c6295c</NextTask> <NewPeople>sample string 27</NewPeople> </Task>
{ "ID": "bbc3c3e5-8d01-46aa-98e4-79bde52e1480", "AncestorID": "0d493aa4-baec-42f6-b473-5d2c81704487", "ParentID": "d982fe2f-20fa-4b34-8fd4-cebd2cd61950", "Name": "sample string 1", "Description": "sample string 2", "Priority": 1, "Rank": 1, "Color": "sample string 3", "HoursActual": 1.0, "HoursProjected": 1.0, "Milestone": true, "TrackingLabel": "sample string 8", "NearHighlightOverride": 1, "SiteID": "711b893a-399e-4bef-9753-01088f7d66a9", "RankPath": "QEA=", "RankOrder": "sample string 9", "DisplayRank": "sample string 10", "Level": 1, "SumHoursActual": 1.0, "SumHoursProjected": 1.0, "Deleted": true, "DeletedByRef": true, "Created": "2025-03-08T05:47:00.1166413+00:00", "CreatedBy": "6dc7ad4d-d591-47fc-8bb2-1e7b7fb041ed", "Updated": "2025-03-08T05:47:00.1166413+00:00", "UpdatedBy": "48bbdf9d-b28e-4ab5-8078-47bef747b6bf", "PeopleResponsible": "sample string 11", "PeopleResponsibleList": [ { "TaskID": "228d6188-7425-4304-913e-40e34995c4e0", "IndividualID": "26e1f87a-0c88-408d-8912-22c0557f6fb5", "HoursProjected": 1.0, "HoursActual": 1.0, "ID": "f08d579d-eea5-4c21-a10d-8eb5672b28c9", "TaskIndividualGroupID": "5469eef5-308e-4a31-a0e2-89b55fa2bdee", "Created": "2025-03-08T05:47:00.1166413+00:00", "CreatedBy": "fa4be17b-458c-41c4-a0c3-0009f231d8ee", "SiteID": "922fe0d8-e5b7-480d-b65e-4c76040a1d48", "Updated": "2025-03-08T05:47:00.1166413+00:00", "UpdatedBy": "b3702608-161d-45f3-9e14-c73e28f233b5", "HoursActualRollup": 1.0, "HoursProjectedRollup": 1.0, "FullName": "sample string 1" }, { "TaskID": "228d6188-7425-4304-913e-40e34995c4e0", "IndividualID": "26e1f87a-0c88-408d-8912-22c0557f6fb5", "HoursProjected": 1.0, "HoursActual": 1.0, "ID": "f08d579d-eea5-4c21-a10d-8eb5672b28c9", "TaskIndividualGroupID": "5469eef5-308e-4a31-a0e2-89b55fa2bdee", "Created": "2025-03-08T05:47:00.1166413+00:00", "CreatedBy": "fa4be17b-458c-41c4-a0c3-0009f231d8ee", "SiteID": "922fe0d8-e5b7-480d-b65e-4c76040a1d48", "Updated": "2025-03-08T05:47:00.1166413+00:00", "UpdatedBy": "b3702608-161d-45f3-9e14-c73e28f233b5", "HoursActualRollup": 1.0, "HoursProjectedRollup": 1.0, "FullName": "sample string 1" } ], "LastComment": "sample string 12", "LastCommentDate": "2025-03-08T05:47:00.1166413+00:00", "LastCommentByID": "051569a1-c5b6-4255-9b7f-c9dd6c3e5f7d", "LastCommentBy": "sample string 13", "Draft": true, "RowType": 1, "AncestorType": 64, "AncestorName": "sample string 14", "ColorName": "sample string 15", "ColorRank": 1, "NearHighlight": 1, "CanRead": true, "CanUpdate": true, "CanDelete": true, "CanDelegate": true, "IsRecurring": true, "Interval": 1, "IntervalQualifier": "sample string 19", "MonthOption": true, "DayOfMonth": 64, "WeekDayInstance": 64, "WeekDay": 64, "Sunday": true, "Monday": true, "Tuesday": true, "Wednesday": true, "Thursday": true, "Friday": true, "Saturday": true, "PreviousTask": "8b1919ca-ae67-4f85-9d8e-c1eb181c7692", "NextTask": "4f3087fe-6af3-439e-8983-520325c6295c", "NewPeople": "sample string 27" }