Request Information

URI Parameters

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

Denotes if the project is currently in the completed status.

isEndDateActualSet boolean

Denotes if the project currently has it's end date actual set.

Body Parameters

None.

Response Information

Resource Description (ReportTask)

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

ID of the Task.

AncestorID globally unique identifier

ID of the ancestor for a task; department, organization, or individual.

ParentID globally unique identifier

ID of the project above a task.

Name string

Name of the task. (Max length 255 characters)

Priority integer

Priority of the task. Valid inputs are: 1= low, 2 = normal, 3 = high, or null.

Rank integer

Rank of the task.

RankPath Collection of byte

Current rank of the given task in a byte array.

RankOrder string

RankOrder to sort rank in the format .0001.0001.0001 (This always returns null when reading a single task by ID.)

DisplayRank string

Rank that is displayed

HoursActual decimal number

Number of actual hours this task took.

StartDateActual string

Date this task was actually started.

EndDateActual string

Date this task was completed.

SumHoursActual decimal number

Sum of the actual number of hours this task took.

SumHoursProjected decimal number

Sum of the number of hours this task is projected to take.

EndDate string

Date the task actually ended or projected to end.

StartDate string

Date the task actually started or projected to start.

ColorName string

Name of the color for the task.

MileStone boolean

Denotes if this is a milestone task or not.

Description string

Task description

Level integer

Indention level on the task.

EndDateProjected string

Date the task is expected to be finished.

StartDateProjected string

Date the task is expected to start.

Response Formats

application/xml, text/xml

Sample
<ReportTask xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <ID>4eec4787-23bd-4bf6-b172-ba7843e5f63b</ID>
  <AncestorID>81a7bd26-a956-46bd-89e9-be4c236b1542</AncestorID>
  <ParentID>526b6651-a352-4fe8-887e-229d2c3d7e6a</ParentID>
  <Name>sample string 1</Name>
  <Priority>1</Priority>
  <Rank>1</Rank>
  <RankPath>QEA=</RankPath>
  <RankOrder>sample string 2</RankOrder>
  <DisplayRank>sample string 3</DisplayRank>
  <HoursActual>1</HoursActual>
  <SumHoursActual>1</SumHoursActual>
  <SumHoursProjected>1</SumHoursProjected>
  <ColorName>sample string 8</ColorName>
  <MileStone>true</MileStone>
  <Description>sample string 9</Description>
  <Level>1</Level>
</ReportTask>

application/json, text/json

Sample
{
  "ID": "4eec4787-23bd-4bf6-b172-ba7843e5f63b",
  "AncestorID": "81a7bd26-a956-46bd-89e9-be4c236b1542",
  "ParentID": "526b6651-a352-4fe8-887e-229d2c3d7e6a",
  "Name": "sample string 1",
  "Priority": 1,
  "Rank": 1,
  "RankPath": "QEA=",
  "RankOrder": "sample string 2",
  "DisplayRank": "sample string 3",
  "HoursActual": 1.0,
  "SumHoursActual": 1.0,
  "SumHoursProjected": 1.0,
  "ColorName": "sample string 8",
  "MileStone": true,
  "Description": "sample string 9",
  "Level": 1
}