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>39cdfdf7-c5bb-490f-ac1d-b481a9f0967b</ID> <AncestorID>895c1f66-7464-4d18-b3a4-f75e6890d5bd</AncestorID> <ParentID>99ec2ce2-d124-47e5-aec1-800ac1e9d8f4</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": "39cdfdf7-c5bb-490f-ac1d-b481a9f0967b",
"AncestorID": "895c1f66-7464-4d18-b3a4-f75e6890d5bd",
"ParentID": "99ec2ce2-d124-47e5-aec1-800ac1e9d8f4",
"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>9f687aec-ca13-4322-8068-16f0666d1ab0</ID>
<AncestorID>38c0e403-ae8f-4051-9d46-18bc1cdd6502</AncestorID>
<ParentID>ed00b695-93b8-4de0-96b0-1f5f92f0ee2f</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>9a31761e-8148-4bcc-833f-6b77d7b0bdf8</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>2026-03-07T18:30:34.8839063+00:00</Created>
<CreatedBy>9cd9bc6b-b0dc-4f5e-84d6-e086c90faf2c</CreatedBy>
<Updated>2026-03-07T18:30:34.8839063+00:00</Updated>
<UpdatedBy>54d3fe55-ea0b-4b2b-8e65-d14eec03856f</UpdatedBy>
<PeopleResponsible>sample string 11</PeopleResponsible>
<PeopleResponsibleList>
<PersonResponsible>
<TaskID>db34f95f-bf68-4379-a852-5cf0ceddbaa9</TaskID>
<IndividualID>25263e3d-9128-48ed-b04d-8d40db872495</IndividualID>
<HoursProjected>1</HoursProjected>
<HoursActual>1</HoursActual>
<ID>7cea2473-38dd-4e16-9899-41afda9e2259</ID>
<TaskIndividualGroupID>c2b9c162-4ada-41ed-b12c-84b38a36d67c</TaskIndividualGroupID>
<Created>2026-03-07T18:30:34.8839063+00:00</Created>
<CreatedBy>e070dcd9-2363-4cbc-b6ce-b26c593a955e</CreatedBy>
<SiteID>bd1c87ce-571f-4b87-9a42-d1de2db42169</SiteID>
<Updated>2026-03-07T18:30:34.8839063+00:00</Updated>
<UpdatedBy>7f4edb19-63c5-4483-9cfe-26d4c36dfebc</UpdatedBy>
<HoursActualRollup>1</HoursActualRollup>
<HoursProjectedRollup>1</HoursProjectedRollup>
<FullName>sample string 1</FullName>
</PersonResponsible>
<PersonResponsible>
<TaskID>db34f95f-bf68-4379-a852-5cf0ceddbaa9</TaskID>
<IndividualID>25263e3d-9128-48ed-b04d-8d40db872495</IndividualID>
<HoursProjected>1</HoursProjected>
<HoursActual>1</HoursActual>
<ID>7cea2473-38dd-4e16-9899-41afda9e2259</ID>
<TaskIndividualGroupID>c2b9c162-4ada-41ed-b12c-84b38a36d67c</TaskIndividualGroupID>
<Created>2026-03-07T18:30:34.8839063+00:00</Created>
<CreatedBy>e070dcd9-2363-4cbc-b6ce-b26c593a955e</CreatedBy>
<SiteID>bd1c87ce-571f-4b87-9a42-d1de2db42169</SiteID>
<Updated>2026-03-07T18:30:34.8839063+00:00</Updated>
<UpdatedBy>7f4edb19-63c5-4483-9cfe-26d4c36dfebc</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>2026-03-07T18:30:34.8839063Z</d2p1:DateTime>
<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
</LastCommentDate>
<LastCommentByID>8b1038df-0676-4d00-aeca-2ee3110cd635</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>62fd6703-05e2-4b2c-8c03-07724dcf8fc1</PreviousTask>
<NextTask>04922eb2-6830-46a6-9000-29abcfd7bb5c</NextTask>
<NewPeople>sample string 27</NewPeople>
</Task>
{
"ID": "9f687aec-ca13-4322-8068-16f0666d1ab0",
"AncestorID": "38c0e403-ae8f-4051-9d46-18bc1cdd6502",
"ParentID": "ed00b695-93b8-4de0-96b0-1f5f92f0ee2f",
"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": "9a31761e-8148-4bcc-833f-6b77d7b0bdf8",
"RankPath": "QEA=",
"RankOrder": "sample string 9",
"DisplayRank": "sample string 10",
"Level": 1,
"SumHoursActual": 1.0,
"SumHoursProjected": 1.0,
"Deleted": true,
"DeletedByRef": true,
"Created": "2026-03-07T18:30:34.8839063+00:00",
"CreatedBy": "9cd9bc6b-b0dc-4f5e-84d6-e086c90faf2c",
"Updated": "2026-03-07T18:30:34.8839063+00:00",
"UpdatedBy": "54d3fe55-ea0b-4b2b-8e65-d14eec03856f",
"PeopleResponsible": "sample string 11",
"PeopleResponsibleList": [
{
"TaskID": "db34f95f-bf68-4379-a852-5cf0ceddbaa9",
"IndividualID": "25263e3d-9128-48ed-b04d-8d40db872495",
"HoursProjected": 1.0,
"HoursActual": 1.0,
"ID": "7cea2473-38dd-4e16-9899-41afda9e2259",
"TaskIndividualGroupID": "c2b9c162-4ada-41ed-b12c-84b38a36d67c",
"Created": "2026-03-07T18:30:34.8839063+00:00",
"CreatedBy": "e070dcd9-2363-4cbc-b6ce-b26c593a955e",
"SiteID": "bd1c87ce-571f-4b87-9a42-d1de2db42169",
"Updated": "2026-03-07T18:30:34.8839063+00:00",
"UpdatedBy": "7f4edb19-63c5-4483-9cfe-26d4c36dfebc",
"HoursActualRollup": 1.0,
"HoursProjectedRollup": 1.0,
"FullName": "sample string 1"
},
{
"TaskID": "db34f95f-bf68-4379-a852-5cf0ceddbaa9",
"IndividualID": "25263e3d-9128-48ed-b04d-8d40db872495",
"HoursProjected": 1.0,
"HoursActual": 1.0,
"ID": "7cea2473-38dd-4e16-9899-41afda9e2259",
"TaskIndividualGroupID": "c2b9c162-4ada-41ed-b12c-84b38a36d67c",
"Created": "2026-03-07T18:30:34.8839063+00:00",
"CreatedBy": "e070dcd9-2363-4cbc-b6ce-b26c593a955e",
"SiteID": "bd1c87ce-571f-4b87-9a42-d1de2db42169",
"Updated": "2026-03-07T18:30:34.8839063+00:00",
"UpdatedBy": "7f4edb19-63c5-4483-9cfe-26d4c36dfebc",
"HoursActualRollup": 1.0,
"HoursProjectedRollup": 1.0,
"FullName": "sample string 1"
}
],
"LastComment": "sample string 12",
"LastCommentDate": "2026-03-07T18:30:34.8839063+00:00",
"LastCommentByID": "8b1038df-0676-4d00-aeca-2ee3110cd635",
"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": "62fd6703-05e2-4b2c-8c03-07724dcf8fc1",
"NextTask": "04922eb2-6830-46a6-9000-29abcfd7bb5c",
"NewPeople": "sample string 27"
}