Create a new task.
|
tz
string
Optional parameter to set time zone information. |
This object takes all the parameters needed to create a new 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>04200bb7-a130-4d84-a02a-60eb6c9c9de4</ID> <AncestorID>982861b2-38f3-4657-9942-a5dc3a15ce61</AncestorID> <ParentID>f6198d71-ff85-4b4b-af4c-92d4a888996a</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": "04200bb7-a130-4d84-a02a-60eb6c9c9de4",
"AncestorID": "982861b2-38f3-4657-9942-a5dc3a15ce61",
"ParentID": "f6198d71-ff85-4b4b-af4c-92d4a888996a",
"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>cc41bd15-cd1e-43c5-8b7f-ede81378ab04</ID>
<AncestorID>4ca2cc2f-5faf-44c0-a647-9023a32b42ec</AncestorID>
<ParentID>8b02607b-a4a0-414c-9343-92fa0131f57b</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>8d8f6175-d57c-449f-9c1c-2174cdd10491</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-10-23T07:48:38.8333085+00:00</Created>
<CreatedBy>9f4e722d-13a5-48e8-9b71-b3855b76fca1</CreatedBy>
<Updated>2025-10-23T07:48:38.8333085+00:00</Updated>
<UpdatedBy>a192d07a-e420-4ea5-bbc0-876a17ab6526</UpdatedBy>
<PeopleResponsible>sample string 11</PeopleResponsible>
<PeopleResponsibleList>
<PersonResponsible>
<TaskID>0d18d7b7-3e76-429d-aaed-5d688c1d8642</TaskID>
<IndividualID>4e43b957-afa9-477a-a83b-32967a338329</IndividualID>
<HoursProjected>1</HoursProjected>
<HoursActual>1</HoursActual>
<ID>bbf87043-8541-4d39-b087-3e5605ca6473</ID>
<TaskIndividualGroupID>ad41e42c-844a-43b8-a405-a8cccb974618</TaskIndividualGroupID>
<Created>2025-10-23T07:48:38.8333085+00:00</Created>
<CreatedBy>33b66b0d-bdc1-4470-bf57-320153dbf250</CreatedBy>
<SiteID>9bb8f72d-e768-4a96-b822-0bd38510127d</SiteID>
<Updated>2025-10-23T07:48:38.8333085+00:00</Updated>
<UpdatedBy>2a490e93-fb8c-493d-a7d6-e6c2f74afd6a</UpdatedBy>
<HoursActualRollup>1</HoursActualRollup>
<HoursProjectedRollup>1</HoursProjectedRollup>
<FullName>sample string 1</FullName>
</PersonResponsible>
<PersonResponsible>
<TaskID>0d18d7b7-3e76-429d-aaed-5d688c1d8642</TaskID>
<IndividualID>4e43b957-afa9-477a-a83b-32967a338329</IndividualID>
<HoursProjected>1</HoursProjected>
<HoursActual>1</HoursActual>
<ID>bbf87043-8541-4d39-b087-3e5605ca6473</ID>
<TaskIndividualGroupID>ad41e42c-844a-43b8-a405-a8cccb974618</TaskIndividualGroupID>
<Created>2025-10-23T07:48:38.8333085+00:00</Created>
<CreatedBy>33b66b0d-bdc1-4470-bf57-320153dbf250</CreatedBy>
<SiteID>9bb8f72d-e768-4a96-b822-0bd38510127d</SiteID>
<Updated>2025-10-23T07:48:38.8333085+00:00</Updated>
<UpdatedBy>2a490e93-fb8c-493d-a7d6-e6c2f74afd6a</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-10-23T07:48:38.8333085Z</d2p1:DateTime>
<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
</LastCommentDate>
<LastCommentByID>944be22a-16dd-499a-9187-8c8b3b8254b0</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>a0a9da77-ea84-43aa-a56e-fb6849b92a90</PreviousTask>
<NextTask>ca78b4a1-e6fd-40bc-80aa-70fd95791682</NextTask>
<NewPeople>sample string 27</NewPeople>
</Task>
{
"ID": "cc41bd15-cd1e-43c5-8b7f-ede81378ab04",
"AncestorID": "4ca2cc2f-5faf-44c0-a647-9023a32b42ec",
"ParentID": "8b02607b-a4a0-414c-9343-92fa0131f57b",
"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": "8d8f6175-d57c-449f-9c1c-2174cdd10491",
"RankPath": "QEA=",
"RankOrder": "sample string 9",
"DisplayRank": "sample string 10",
"Level": 1,
"SumHoursActual": 1.0,
"SumHoursProjected": 1.0,
"Deleted": true,
"DeletedByRef": true,
"Created": "2025-10-23T07:48:38.8333085+00:00",
"CreatedBy": "9f4e722d-13a5-48e8-9b71-b3855b76fca1",
"Updated": "2025-10-23T07:48:38.8333085+00:00",
"UpdatedBy": "a192d07a-e420-4ea5-bbc0-876a17ab6526",
"PeopleResponsible": "sample string 11",
"PeopleResponsibleList": [
{
"TaskID": "0d18d7b7-3e76-429d-aaed-5d688c1d8642",
"IndividualID": "4e43b957-afa9-477a-a83b-32967a338329",
"HoursProjected": 1.0,
"HoursActual": 1.0,
"ID": "bbf87043-8541-4d39-b087-3e5605ca6473",
"TaskIndividualGroupID": "ad41e42c-844a-43b8-a405-a8cccb974618",
"Created": "2025-10-23T07:48:38.8333085+00:00",
"CreatedBy": "33b66b0d-bdc1-4470-bf57-320153dbf250",
"SiteID": "9bb8f72d-e768-4a96-b822-0bd38510127d",
"Updated": "2025-10-23T07:48:38.8333085+00:00",
"UpdatedBy": "2a490e93-fb8c-493d-a7d6-e6c2f74afd6a",
"HoursActualRollup": 1.0,
"HoursProjectedRollup": 1.0,
"FullName": "sample string 1"
},
{
"TaskID": "0d18d7b7-3e76-429d-aaed-5d688c1d8642",
"IndividualID": "4e43b957-afa9-477a-a83b-32967a338329",
"HoursProjected": 1.0,
"HoursActual": 1.0,
"ID": "bbf87043-8541-4d39-b087-3e5605ca6473",
"TaskIndividualGroupID": "ad41e42c-844a-43b8-a405-a8cccb974618",
"Created": "2025-10-23T07:48:38.8333085+00:00",
"CreatedBy": "33b66b0d-bdc1-4470-bf57-320153dbf250",
"SiteID": "9bb8f72d-e768-4a96-b822-0bd38510127d",
"Updated": "2025-10-23T07:48:38.8333085+00:00",
"UpdatedBy": "2a490e93-fb8c-493d-a7d6-e6c2f74afd6a",
"HoursActualRollup": 1.0,
"HoursProjectedRollup": 1.0,
"FullName": "sample string 1"
}
],
"LastComment": "sample string 12",
"LastCommentDate": "2025-10-23T07:48:38.8333085+00:00",
"LastCommentByID": "944be22a-16dd-499a-9187-8c8b3b8254b0",
"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": "a0a9da77-ea84-43aa-a56e-fb6849b92a90",
"NextTask": "ca78b4a1-e6fd-40bc-80aa-70fd95791682",
"NewPeople": "sample string 27"
}