GET tasks/{id}?tz={tz}

Request Information

URI Parameters

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList

Name	Description
id `globally unique identifier` Required Guid ID of the task to be read.	`globally unique identifier` Required Guid ID of the task to be read.
tz `string` Optional parameter to set time zone information.	`string` Optional parameter to set time zone information.

Body Parameters

None.

Response Information

Resource Description (Task)

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList

Response Formats

application/xml, text/xml

Sample

<Task xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <ID>ad8bdc64-9bee-4040-ab54-d9f7d068089e</ID>
  <AncestorID>e5882361-3846-4bd8-9097-613c900c208a</AncestorID>
  <ParentID>d018cd5e-f695-4ea2-9e1e-26c9ffa9d113</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>d5e895e5-731e-4ba9-9fd3-71c89c696876</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-10-23T22:07:26.3028238+00:00</Created>
  <CreatedBy>ca199312-202d-4f3a-bc1e-ba8ba6f45a0d</CreatedBy>
  <Updated>2024-10-23T22:07:26.3028238+00:00</Updated>
  <UpdatedBy>6147a499-9749-430f-9c33-447e3fde46e5</UpdatedBy>
  <PeopleResponsible>sample string 11</PeopleResponsible>
  <PeopleResponsibleList>
    <PersonResponsible>
      <TaskID>62beafd1-f2c5-4500-b345-b21875a41007</TaskID>
      <IndividualID>a4c8e70a-e349-44ce-9d44-f8ffa6b48984</IndividualID>
      <HoursProjected>1</HoursProjected>
      <HoursActual>1</HoursActual>
      <ID>ff839e41-32f7-4ef5-8479-02565e21c927</ID>
      <TaskIndividualGroupID>2116697d-b0f5-44a3-bd72-55d8c1e61f92</TaskIndividualGroupID>
      <Created>2024-10-23T22:07:26.3028238+00:00</Created>
      <CreatedBy>251a6e06-731b-4c8b-9cd6-030cf30ab651</CreatedBy>
      <SiteID>ba789849-7b20-4cdf-b2c1-627c334549af</SiteID>
      <Updated>2024-10-23T22:07:26.3028238+00:00</Updated>
      <UpdatedBy>5fed18ab-a81b-414d-9117-900c2d1b01cf</UpdatedBy>
      <HoursActualRollup>1</HoursActualRollup>
      <HoursProjectedRollup>1</HoursProjectedRollup>
      <FullName>sample string 1</FullName>
    </PersonResponsible>
    <PersonResponsible>
      <TaskID>62beafd1-f2c5-4500-b345-b21875a41007</TaskID>
      <IndividualID>a4c8e70a-e349-44ce-9d44-f8ffa6b48984</IndividualID>
      <HoursProjected>1</HoursProjected>
      <HoursActual>1</HoursActual>
      <ID>ff839e41-32f7-4ef5-8479-02565e21c927</ID>
      <TaskIndividualGroupID>2116697d-b0f5-44a3-bd72-55d8c1e61f92</TaskIndividualGroupID>
      <Created>2024-10-23T22:07:26.3028238+00:00</Created>
      <CreatedBy>251a6e06-731b-4c8b-9cd6-030cf30ab651</CreatedBy>
      <SiteID>ba789849-7b20-4cdf-b2c1-627c334549af</SiteID>
      <Updated>2024-10-23T22:07:26.3028238+00:00</Updated>
      <UpdatedBy>5fed18ab-a81b-414d-9117-900c2d1b01cf</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-10-23T22:07:26.3028238Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </LastCommentDate>
  <LastCommentByID>82afcdce-e9ad-431f-a513-d2231784c6b3</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>ca874a4e-da20-4664-9418-dcb3e9f9e263</PreviousTask>
  <NextTask>9cc3f88f-4730-4d1d-8a50-73aeb7f3f584</NextTask>
  <NewPeople>sample string 27</NewPeople>
</Task>

application/json, text/json

Sample

{
  "ID": "ad8bdc64-9bee-4040-ab54-d9f7d068089e",
  "AncestorID": "e5882361-3846-4bd8-9097-613c900c208a",
  "ParentID": "d018cd5e-f695-4ea2-9e1e-26c9ffa9d113",
  "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": "d5e895e5-731e-4ba9-9fd3-71c89c696876",
  "RankPath": "QEA=",
  "RankOrder": "sample string 9",
  "DisplayRank": "sample string 10",
  "Level": 1,
  "SumHoursActual": 1.0,
  "SumHoursProjected": 1.0,
  "Deleted": true,
  "DeletedByRef": true,
  "Created": "2024-10-23T22:07:26.3028238+00:00",
  "CreatedBy": "ca199312-202d-4f3a-bc1e-ba8ba6f45a0d",
  "Updated": "2024-10-23T22:07:26.3028238+00:00",
  "UpdatedBy": "6147a499-9749-430f-9c33-447e3fde46e5",
  "PeopleResponsible": "sample string 11",
  "PeopleResponsibleList": [
    {
      "TaskID": "62beafd1-f2c5-4500-b345-b21875a41007",
      "IndividualID": "a4c8e70a-e349-44ce-9d44-f8ffa6b48984",
      "HoursProjected": 1.0,
      "HoursActual": 1.0,
      "ID": "ff839e41-32f7-4ef5-8479-02565e21c927",
      "TaskIndividualGroupID": "2116697d-b0f5-44a3-bd72-55d8c1e61f92",
      "Created": "2024-10-23T22:07:26.3028238+00:00",
      "CreatedBy": "251a6e06-731b-4c8b-9cd6-030cf30ab651",
      "SiteID": "ba789849-7b20-4cdf-b2c1-627c334549af",
      "Updated": "2024-10-23T22:07:26.3028238+00:00",
      "UpdatedBy": "5fed18ab-a81b-414d-9117-900c2d1b01cf",
      "HoursActualRollup": 1.0,
      "HoursProjectedRollup": 1.0,
      "FullName": "sample string 1"
    },
    {
      "TaskID": "62beafd1-f2c5-4500-b345-b21875a41007",
      "IndividualID": "a4c8e70a-e349-44ce-9d44-f8ffa6b48984",
      "HoursProjected": 1.0,
      "HoursActual": 1.0,
      "ID": "ff839e41-32f7-4ef5-8479-02565e21c927",
      "TaskIndividualGroupID": "2116697d-b0f5-44a3-bd72-55d8c1e61f92",
      "Created": "2024-10-23T22:07:26.3028238+00:00",
      "CreatedBy": "251a6e06-731b-4c8b-9cd6-030cf30ab651",
      "SiteID": "ba789849-7b20-4cdf-b2c1-627c334549af",
      "Updated": "2024-10-23T22:07:26.3028238+00:00",
      "UpdatedBy": "5fed18ab-a81b-414d-9117-900c2d1b01cf",
      "HoursActualRollup": 1.0,
      "HoursProjectedRollup": 1.0,
      "FullName": "sample string 1"
    }
  ],
  "LastComment": "sample string 12",
  "LastCommentDate": "2024-10-23T22:07:26.3028238+00:00",
  "LastCommentByID": "82afcdce-e9ad-431f-a513-d2231784c6b3",
  "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": "ca874a4e-da20-4664-9418-dcb3e9f9e263",
  "NextTask": "9cc3f88f-4730-4d1d-8a50-73aeb7f3f584",
  "NewPeople": "sample string 27"
}

Name	Description
ID `globally unique identifier` Required on Update ID of the Task.	`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.	`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.	`globally unique identifier` ID of the project above a task.
Name `string` Required Name of the task. (Max length 255 characters)	`string` Required Name of the task. (Max length 255 characters)
Description `string` Description of the task.	`string` Description of the task.
Priority `integer` Priority of the task. Valid inputs are: 1= low, 2 = normal, 3 = high, or null.	`integer` Priority of the task. Valid inputs are: 1= low, 2 = normal, 3 = high, or null.
Rank `integer` Rank of the task.	`integer` Rank of the task.
Color `string` Hex value for the color of the given task.	`string` Hex value for the color of the given task.
HoursActual `decimal number` Number of actual hours this task took.	`decimal number` Number of actual hours this task took.
HoursProjected `decimal number` Number of hours this task is projected to take.	`decimal number` Number of hours this task is projected to take.
StartDateActual `string` Date this task was actually started.	`string` Date this task was actually started.
StartDateProjected `string` Date this task is projected to start.	`string` Date this task is projected to start.
EndDateActual `string` Date this task was completed.	`string` Date this task was completed.
EndDateProjected `string` Date this task is projected to complete.	`string` Date this task is projected to complete.
Milestone `boolean` Displays if this task is a milestone or not.	`boolean` Displays if this task is a milestone or not.
TrackingLabel `string` Customizable label for task. (Max length 50 characters)	`string` Customizable label for task. (Max length 50 characters)
NearHighlightOverride `integer` Override the near due date highlights settings for a specific task.	`integer` Override the near due date highlights settings for a specific task.
SiteID `globally unique identifier` ReadOnly ID of the site for the task.	`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.	`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.)	`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	`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.)	`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.	`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.	`decimal number` ReadOnly Sum of the number of hours this task is projected to take.
Deleted `boolean` ReadOnly Deleted status of the task.	`boolean` ReadOnly Deleted status of the task.
DeletedByRef `boolean` ReadOnly Deleted by reference status of the task.	`boolean` ReadOnly Deleted by reference status of the task.
Created `date` ReadOnly Date the task was created.	`date` ReadOnly Date the task was created.
CreatedBy `globally unique identifier` ReadOnly ID of the person that created the task.	`globally unique identifier` ReadOnly ID of the person that created the task.
Updated `date` ReadOnly Date when the task was last updated.	`date` ReadOnly Date when the task was last updated.
UpdatedBy `globally unique identifier` ReadOnly ID of the person that updated the task.	`globally unique identifier` ReadOnly ID of the person that updated the task.
PeopleResponsible `string` ReadOnly Names of the People responsible for this task.	`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.	`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.	`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.	`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.	`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.	`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.	`boolean` ReadOnly Displays if this task is a draft or not.
RowType `integer` ReadOnly Row type of the task.	`integer` ReadOnly Row type of the task.
AncestorType `byte` ReadOnly Row type of the Ancestor.	`byte` ReadOnly Row type of the Ancestor.
AncestorName `string` ReadOnly Name of the task's Ancestor.	`string` ReadOnly Name of the task's Ancestor.
ColorName `string` ReadOnly Name of the task's color.	`string` ReadOnly Name of the task's color.
ColorRank `integer` ReadOnly Rank of the task's color.	`integer` ReadOnly Rank of the task's color.
EndDate `string` ReadOnly Date the task actually ended or projected to end.	`string` ReadOnly Date the task actually ended or projected to end.
StartDate `string` ReadOnly Date the task actually started or projected to start.	`string` ReadOnly Date the task actually started or projected to start.
NearHighlight `integer` ReadOnly Near due date highlights settings for a specific task.	`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.	`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.	`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.	`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.	`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.	`boolean` This denotes if the task will reoccur when it is completed.
Interval `integer` Interval of the recurring task.	`integer` Interval of the recurring task.
IntervalQualifier `string` Interval type for the task. This can be: Day, Month, Week, or Year	`string` Interval type for the task. This can be: Day, Month, Week, or Year
MonthOption `boolean` If it is monthly ex 2nd tuesday	`boolean` If it is monthly ex 2nd tuesday
DayOfMonth `byte` Sets day of the month the task should reoccur	`byte` Sets day of the month the task should reoccur
WeekDayInstance `byte` 1-5 Tuesday	`byte` 1-5 Tuesday
WeekDay `byte` Day of the week.	`byte` Day of the week.
Sunday `boolean` Denotes if this task should repeat on Sunday.	`boolean` Denotes if this task should repeat on Sunday.
Monday `boolean` Denotes if this task should repeat on Monday.	`boolean` Denotes if this task should repeat on Monday.
Tuesday `boolean` Denotes if this task should repeat on Tuesday.	`boolean` Denotes if this task should repeat on Tuesday.
Wednesday `boolean` Denotes if this task should repeat on Wednesday.	`boolean` Denotes if this task should repeat on Wednesday.
Thursday `boolean` Denotes if this task should repeat on Thursday.	`boolean` Denotes if this task should repeat on Thursday.
Friday `boolean` Denotes if this task should repeat on Friday.	`boolean` Denotes if this task should repeat on Friday.
Saturday `boolean` Denotes if this task should repeat on Saturday.	`boolean` Denotes if this task should repeat on Saturday.
PreviousTask `globally unique identifier` ReadOnly ID of the previous task.	`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.	`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.	`string` List of comma separated GUID Individual IDs to add to a new task.