Request Information

URI Parameters

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList
dialogId globally unique identifier Required

Guid ID of the dialog.

siteId globally unique identifier

Site ID for the dialog. (Deprecated)

tz 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
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.

Response Formats

application/xml, text/xml

Sample
<Task xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <ID>771b95f2-1830-4a97-8afb-9a49f1172c13</ID>
  <AncestorID>c3cc9ee5-460b-4960-972f-6f6e95b35165</AncestorID>
  <ParentID>65a1cbb4-e488-490a-8622-08de864780ac</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>60171aaa-c8b5-487e-a680-339080885e7c</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>2021-11-03T19:08:09.9671017+00:00</Created>
  <CreatedBy>9acaf265-a224-49df-8e5c-2e490cc49162</CreatedBy>
  <Updated>2021-11-03T19:08:09.9671017+00:00</Updated>
  <UpdatedBy>d6c36082-b3bb-41e7-9c60-d2e926f569a9</UpdatedBy>
  <PeopleResponsible>sample string 11</PeopleResponsible>
  <PeopleResponsibleList>
    <PersonResponsible>
      <TaskID>b1e53d4a-a2fa-4c98-9ff9-e279a6d7256f</TaskID>
      <IndividualID>11051445-2e3f-4f2e-9db2-0df07b061824</IndividualID>
      <HoursProjected>1</HoursProjected>
      <HoursActual>1</HoursActual>
      <ID>8f04d9a7-f24c-4dd5-865c-a23a55eb041c</ID>
      <TaskIndividualGroupID>66a0ed6e-c814-4d49-ab97-11ae04925bc6</TaskIndividualGroupID>
      <Created>2021-11-03T19:08:09.9671017+00:00</Created>
      <CreatedBy>cba78730-4ef5-4ea0-8751-4adafe5d3807</CreatedBy>
      <SiteID>4f0e7d64-565c-4811-ad92-434ab888f88c</SiteID>
      <Updated>2021-11-03T19:08:09.9671017+00:00</Updated>
      <UpdatedBy>88adf450-da22-40d7-be2d-1fbbb197dc03</UpdatedBy>
      <HoursActualRollup>1</HoursActualRollup>
      <HoursProjectedRollup>1</HoursProjectedRollup>
      <FullName>sample string 1</FullName>
    </PersonResponsible>
    <PersonResponsible>
      <TaskID>b1e53d4a-a2fa-4c98-9ff9-e279a6d7256f</TaskID>
      <IndividualID>11051445-2e3f-4f2e-9db2-0df07b061824</IndividualID>
      <HoursProjected>1</HoursProjected>
      <HoursActual>1</HoursActual>
      <ID>8f04d9a7-f24c-4dd5-865c-a23a55eb041c</ID>
      <TaskIndividualGroupID>66a0ed6e-c814-4d49-ab97-11ae04925bc6</TaskIndividualGroupID>
      <Created>2021-11-03T19:08:09.9671017+00:00</Created>
      <CreatedBy>cba78730-4ef5-4ea0-8751-4adafe5d3807</CreatedBy>
      <SiteID>4f0e7d64-565c-4811-ad92-434ab888f88c</SiteID>
      <Updated>2021-11-03T19:08:09.9671017+00:00</Updated>
      <UpdatedBy>88adf450-da22-40d7-be2d-1fbbb197dc03</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>2021-11-03T19:08:09.9671017Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </LastCommentDate>
  <LastCommentByID>ec0f4398-3847-46e4-9281-955a8baa0345</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>fce244aa-645a-4422-8c8f-e1fd2ea023ec</PreviousTask>
  <NextTask>391702bc-2877-4208-b3fb-4e80e53745be</NextTask>
  <NewPeople>sample string 27</NewPeople>
</Task>

application/json, text/json

Sample
{
  "ID": "771b95f2-1830-4a97-8afb-9a49f1172c13",
  "AncestorID": "c3cc9ee5-460b-4960-972f-6f6e95b35165",
  "ParentID": "65a1cbb4-e488-490a-8622-08de864780ac",
  "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": "60171aaa-c8b5-487e-a680-339080885e7c",
  "RankPath": "QEA=",
  "RankOrder": "sample string 9",
  "DisplayRank": "sample string 10",
  "Level": 1,
  "SumHoursActual": 1.0,
  "SumHoursProjected": 1.0,
  "Deleted": true,
  "DeletedByRef": true,
  "Created": "2021-11-03T19:08:09.9671017+00:00",
  "CreatedBy": "9acaf265-a224-49df-8e5c-2e490cc49162",
  "Updated": "2021-11-03T19:08:09.9671017+00:00",
  "UpdatedBy": "d6c36082-b3bb-41e7-9c60-d2e926f569a9",
  "PeopleResponsible": "sample string 11",
  "PeopleResponsibleList": [
    {
      "TaskID": "b1e53d4a-a2fa-4c98-9ff9-e279a6d7256f",
      "IndividualID": "11051445-2e3f-4f2e-9db2-0df07b061824",
      "HoursProjected": 1.0,
      "HoursActual": 1.0,
      "ID": "8f04d9a7-f24c-4dd5-865c-a23a55eb041c",
      "TaskIndividualGroupID": "66a0ed6e-c814-4d49-ab97-11ae04925bc6",
      "Created": "2021-11-03T19:08:09.9671017+00:00",
      "CreatedBy": "cba78730-4ef5-4ea0-8751-4adafe5d3807",
      "SiteID": "4f0e7d64-565c-4811-ad92-434ab888f88c",
      "Updated": "2021-11-03T19:08:09.9671017+00:00",
      "UpdatedBy": "88adf450-da22-40d7-be2d-1fbbb197dc03",
      "HoursActualRollup": 1.0,
      "HoursProjectedRollup": 1.0,
      "FullName": "sample string 1"
    },
    {
      "TaskID": "b1e53d4a-a2fa-4c98-9ff9-e279a6d7256f",
      "IndividualID": "11051445-2e3f-4f2e-9db2-0df07b061824",
      "HoursProjected": 1.0,
      "HoursActual": 1.0,
      "ID": "8f04d9a7-f24c-4dd5-865c-a23a55eb041c",
      "TaskIndividualGroupID": "66a0ed6e-c814-4d49-ab97-11ae04925bc6",
      "Created": "2021-11-03T19:08:09.9671017+00:00",
      "CreatedBy": "cba78730-4ef5-4ea0-8751-4adafe5d3807",
      "SiteID": "4f0e7d64-565c-4811-ad92-434ab888f88c",
      "Updated": "2021-11-03T19:08:09.9671017+00:00",
      "UpdatedBy": "88adf450-da22-40d7-be2d-1fbbb197dc03",
      "HoursActualRollup": 1.0,
      "HoursProjectedRollup": 1.0,
      "FullName": "sample string 1"
    }
  ],
  "LastComment": "sample string 12",
  "LastCommentDate": "2021-11-03T19:08:09.9671017+00:00",
  "LastCommentByID": "ec0f4398-3847-46e4-9281-955a8baa0345",
  "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": "fce244aa-645a-4422-8c8f-e1fd2ea023ec",
  "NextTask": "391702bc-2877-4208-b3fb-4e80e53745be",
  "NewPeople": "sample string 27"
}