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>9e260330-2032-4795-9fd1-cd2dab1b7844</ID> <AncestorID>15ba724f-b1ca-47b0-828d-32d55067999c</AncestorID> <ParentID>4db971e9-cc02-41ff-a0e4-64a0e12185d6</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": "9e260330-2032-4795-9fd1-cd2dab1b7844", "AncestorID": "15ba724f-b1ca-47b0-828d-32d55067999c", "ParentID": "4db971e9-cc02-41ff-a0e4-64a0e12185d6", "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>6439a0cf-cba3-4c98-b98b-15d14c590586</ID> <AncestorID>fb78d03b-d159-4c13-a251-c857a21d6c6b</AncestorID> <ParentID>10d24b9b-ea00-40e4-ae35-40a5cb1fe637</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>fdbe823a-60dc-448d-b1a0-631c8d095406</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>2024-04-13T04:42:36.7586789+00:00</Created> <CreatedBy>41caf4aa-2ef0-42a2-a688-1032d0b740d5</CreatedBy> <Updated>2024-04-13T04:42:36.7586789+00:00</Updated> <UpdatedBy>446d7163-95f6-4997-b0ac-1a612be4dbf2</UpdatedBy> <PeopleResponsible>sample string 11</PeopleResponsible> <PeopleResponsibleList> <PersonResponsible> <TaskID>09dba08a-b4a6-47ca-8268-e747406b6ba4</TaskID> <IndividualID>74fd9a20-5b29-4335-874e-4760ea6cd42d</IndividualID> <HoursProjected>1</HoursProjected> <HoursActual>1</HoursActual> <ID>19ca224c-1422-4681-aad3-b809d007bcd8</ID> <TaskIndividualGroupID>89bd7ecf-eaa6-4437-99be-47c94c9454e4</TaskIndividualGroupID> <Created>2024-04-13T04:42:36.7586789+00:00</Created> <CreatedBy>c6a37499-0331-4231-9a32-fbdbfde9c207</CreatedBy> <SiteID>706d5c63-e215-4a39-abbc-3e6beb24cb47</SiteID> <Updated>2024-04-13T04:42:36.7586789+00:00</Updated> <UpdatedBy>01bb0644-86c2-45b5-b4e5-34e84a5b83cb</UpdatedBy> <HoursActualRollup>1</HoursActualRollup> <HoursProjectedRollup>1</HoursProjectedRollup> <FullName>sample string 1</FullName> </PersonResponsible> <PersonResponsible> <TaskID>09dba08a-b4a6-47ca-8268-e747406b6ba4</TaskID> <IndividualID>74fd9a20-5b29-4335-874e-4760ea6cd42d</IndividualID> <HoursProjected>1</HoursProjected> <HoursActual>1</HoursActual> <ID>19ca224c-1422-4681-aad3-b809d007bcd8</ID> <TaskIndividualGroupID>89bd7ecf-eaa6-4437-99be-47c94c9454e4</TaskIndividualGroupID> <Created>2024-04-13T04:42:36.7586789+00:00</Created> <CreatedBy>c6a37499-0331-4231-9a32-fbdbfde9c207</CreatedBy> <SiteID>706d5c63-e215-4a39-abbc-3e6beb24cb47</SiteID> <Updated>2024-04-13T04:42:36.7586789+00:00</Updated> <UpdatedBy>01bb0644-86c2-45b5-b4e5-34e84a5b83cb</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>2024-04-13T04:42:36.7586789Z</d2p1:DateTime> <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes> </LastCommentDate> <LastCommentByID>36ce7b3b-ba50-4a30-84d1-5434f7663e31</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>60fafd77-66c8-46c1-a066-8888c4cefc50</PreviousTask> <NextTask>60893c93-7e1a-4fc0-9758-fab32ad919bd</NextTask> <NewPeople>sample string 27</NewPeople> </Task>
{ "ID": "6439a0cf-cba3-4c98-b98b-15d14c590586", "AncestorID": "fb78d03b-d159-4c13-a251-c857a21d6c6b", "ParentID": "10d24b9b-ea00-40e4-ae35-40a5cb1fe637", "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": "fdbe823a-60dc-448d-b1a0-631c8d095406", "RankPath": "QEA=", "RankOrder": "sample string 9", "DisplayRank": "sample string 10", "Level": 1, "SumHoursActual": 1.0, "SumHoursProjected": 1.0, "Deleted": true, "DeletedByRef": true, "Created": "2024-04-13T04:42:36.7586789+00:00", "CreatedBy": "41caf4aa-2ef0-42a2-a688-1032d0b740d5", "Updated": "2024-04-13T04:42:36.7586789+00:00", "UpdatedBy": "446d7163-95f6-4997-b0ac-1a612be4dbf2", "PeopleResponsible": "sample string 11", "PeopleResponsibleList": [ { "TaskID": "09dba08a-b4a6-47ca-8268-e747406b6ba4", "IndividualID": "74fd9a20-5b29-4335-874e-4760ea6cd42d", "HoursProjected": 1.0, "HoursActual": 1.0, "ID": "19ca224c-1422-4681-aad3-b809d007bcd8", "TaskIndividualGroupID": "89bd7ecf-eaa6-4437-99be-47c94c9454e4", "Created": "2024-04-13T04:42:36.7586789+00:00", "CreatedBy": "c6a37499-0331-4231-9a32-fbdbfde9c207", "SiteID": "706d5c63-e215-4a39-abbc-3e6beb24cb47", "Updated": "2024-04-13T04:42:36.7586789+00:00", "UpdatedBy": "01bb0644-86c2-45b5-b4e5-34e84a5b83cb", "HoursActualRollup": 1.0, "HoursProjectedRollup": 1.0, "FullName": "sample string 1" }, { "TaskID": "09dba08a-b4a6-47ca-8268-e747406b6ba4", "IndividualID": "74fd9a20-5b29-4335-874e-4760ea6cd42d", "HoursProjected": 1.0, "HoursActual": 1.0, "ID": "19ca224c-1422-4681-aad3-b809d007bcd8", "TaskIndividualGroupID": "89bd7ecf-eaa6-4437-99be-47c94c9454e4", "Created": "2024-04-13T04:42:36.7586789+00:00", "CreatedBy": "c6a37499-0331-4231-9a32-fbdbfde9c207", "SiteID": "706d5c63-e215-4a39-abbc-3e6beb24cb47", "Updated": "2024-04-13T04:42:36.7586789+00:00", "UpdatedBy": "01bb0644-86c2-45b5-b4e5-34e84a5b83cb", "HoursActualRollup": 1.0, "HoursProjectedRollup": 1.0, "FullName": "sample string 1" } ], "LastComment": "sample string 12", "LastCommentDate": "2024-04-13T04:42:36.7586789+00:00", "LastCommentByID": "36ce7b3b-ba50-4a30-84d1-5434f7663e31", "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": "60fafd77-66c8-46c1-a066-8888c4cefc50", "NextTask": "60893c93-7e1a-4fc0-9758-fab32ad919bd", "NewPeople": "sample string 27" }