GET dashboards/{id}/projects/active?period={period}&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 organization, department or individual for the project.	`globally unique identifier` Required Guid ID of the organization, department or individual for the project.
period `integer` Optional period ID filter. Defaults to the current period.	`integer` Optional period ID filter. Defaults to the current period.
tz `string` Optional parameter to set time zone information.	`string` Optional parameter to set time zone information.

Body Parameters

None.

Response Information

Resource Description (Project)

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

Response Formats

application/xml, text/xml

Sample

<Project xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <ID>5e793e38-9fc9-42d9-929a-27d7e59c01ba</ID>
  <ParentID>67f1c295-fb06-40b3-88b1-e0a3aacb9094</ParentID>
  <AncestorID>015729d6-4666-4fe8-b38a-db40c6099e27</AncestorID>
  <Rank>1</Rank>
  <Color>sample string 1</Color>
  <HoursActual>1</HoursActual>
  <HoursProjected>1</HoursProjected>
  <TrackingLabel>sample string 6</TrackingLabel>
  <NearHighlightOverride>1</NearHighlightOverride>
  <Name>sample string 7</Name>
  <Description>sample string 8</Description>
  <StatusID>1</StatusID>
  <PhaseID>1</PhaseID>
  <AncestorName>sample string 9</AncestorName>
  <RankOrder>sample string 10</RankOrder>
  <DisplayRank>sample string 11</DisplayRank>
  <Level>1</Level>
  <SumHoursActual>1</SumHoursActual>
  <SumHoursProjected>1</SumHoursProjected>
  <Status>sample string 12</Status>
  <Phase>sample string 13</Phase>
  <Deleted>true</Deleted>
  <DeletedByRef>true</DeletedByRef>
  <Created>sample string 14</Created>
  <CreatedBy>2dd347d2-b491-4c3a-be85-0d35ccda6050</CreatedBy>
  <Updated>2024-10-24T07:56:57.2780367+00:00</Updated>
  <UpdatedBy>d65b177c-35cf-4d98-9106-3edc39792d9a</UpdatedBy>
  <TeamMembers>sample string 15</TeamMembers>
  <LastComment>sample string 16</LastComment>
  <LastCommentDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2024-10-24T07:56:57.2780367Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </LastCommentDate>
  <LastCommentByID>a4160f29-9bb0-41f9-a385-4100ba416d96</LastCommentByID>
  <LastCommentBy>sample string 17</LastCommentBy>
  <EndDateChanges>1</EndDateChanges>
  <IncludeSurveys>true</IncludeSurveys>
  <AncestorType>1</AncestorType>
  <Draft>true</Draft>
  <LinkedToID>e4fd61b0-faf6-4e38-9556-23e2642a3469</LinkedToID>
  <TeamMemberList>
    <TeamMember>
      <TaskID>0bd39d83-2e7f-431c-a446-f3d4511a99d0</TaskID>
      <IndividualID>1be11178-23db-4b69-a752-357f8f77ad44</IndividualID>
      <RoleID>ed7be881-c5ed-4078-bc12-f75d55a6be48</RoleID>
      <HoursProjected>1</HoursProjected>
      <HoursActual>1</HoursActual>
      <ID>d6ad8448-7488-4bc5-9c6e-ab66c080caa4</ID>
      <RoleName>sample string 1</RoleName>
      <HoursActualRollup>1</HoursActualRollup>
      <HoursProjectedRollup>1</HoursProjectedRollup>
      <IndividualFullName>sample string 2</IndividualFullName>
      <Created>2024-10-24T07:56:57.2780367+00:00</Created>
      <CreatedBy>44387e42-baa6-4f64-b3b4-53ccc375a05b</CreatedBy>
      <SiteID>815aa2f2-a099-445b-af63-fa9b5ee948a2</SiteID>
      <Updated>2024-10-24T07:56:57.2780367+00:00</Updated>
      <UpdatedBy>234dad33-f200-402e-a7d7-df2cfca8b215</UpdatedBy>
      <IndividualFullOrderedName>sample string 3</IndividualFullOrderedName>
      <RoleDescription>sample string 4</RoleDescription>
      <TeamSurvey>true</TeamSurvey>
    </TeamMember>
    <TeamMember>
      <TaskID>0bd39d83-2e7f-431c-a446-f3d4511a99d0</TaskID>
      <IndividualID>1be11178-23db-4b69-a752-357f8f77ad44</IndividualID>
      <RoleID>ed7be881-c5ed-4078-bc12-f75d55a6be48</RoleID>
      <HoursProjected>1</HoursProjected>
      <HoursActual>1</HoursActual>
      <ID>d6ad8448-7488-4bc5-9c6e-ab66c080caa4</ID>
      <RoleName>sample string 1</RoleName>
      <HoursActualRollup>1</HoursActualRollup>
      <HoursProjectedRollup>1</HoursProjectedRollup>
      <IndividualFullName>sample string 2</IndividualFullName>
      <Created>2024-10-24T07:56:57.2780367+00:00</Created>
      <CreatedBy>44387e42-baa6-4f64-b3b4-53ccc375a05b</CreatedBy>
      <SiteID>815aa2f2-a099-445b-af63-fa9b5ee948a2</SiteID>
      <Updated>2024-10-24T07:56:57.2780367+00:00</Updated>
      <UpdatedBy>234dad33-f200-402e-a7d7-df2cfca8b215</UpdatedBy>
      <IndividualFullOrderedName>sample string 3</IndividualFullOrderedName>
      <RoleDescription>sample string 4</RoleDescription>
      <TeamSurvey>true</TeamSurvey>
    </TeamMember>
  </TeamMemberList>
  <StatusName>sample string 18</StatusName>
  <StatusRank>1</StatusRank>
  <PhaseName>sample string 19</PhaseName>
  <PhaseRank>1</PhaseRank>
  <ColorName>sample string 20</ColorName>
  <ColorRank>1</ColorRank>
  <LinkedAncestorID>4192b7b8-fafc-4339-a961-2c8bcf99cf47</LinkedAncestorID>
  <LinkedToName>sample string 21</LinkedToName>
  <LinkedToRowType>1</LinkedToRowType>
  <LinkedAncestorName>sample string 22</LinkedAncestorName>
  <RowType>1</RowType>
  <RankPath>QEA=</RankPath>
  <OnTime>true</OnTime>
  <CanRead>true</CanRead>
  <CanUpdate>true</CanUpdate>
  <CanDelete>true</CanDelete>
  <CanDelegate>true</CanDelegate>
  <NearHighlight>1</NearHighlight>
</Project>

application/json, text/json

Sample

{
  "ID": "5e793e38-9fc9-42d9-929a-27d7e59c01ba",
  "ParentID": "67f1c295-fb06-40b3-88b1-e0a3aacb9094",
  "AncestorID": "015729d6-4666-4fe8-b38a-db40c6099e27",
  "Rank": 1,
  "Color": "sample string 1",
  "HoursActual": 1.0,
  "HoursProjected": 1.0,
  "TrackingLabel": "sample string 6",
  "NearHighlightOverride": 1,
  "Name": "sample string 7",
  "Description": "sample string 8",
  "StatusID": 1,
  "PhaseID": 1,
  "AncestorName": "sample string 9",
  "RankOrder": "sample string 10",
  "DisplayRank": "sample string 11",
  "Level": 1,
  "SumHoursActual": 1.0,
  "SumHoursProjected": 1.0,
  "Status": "sample string 12",
  "Phase": "sample string 13",
  "Deleted": true,
  "DeletedByRef": true,
  "Created": "sample string 14",
  "CreatedBy": "2dd347d2-b491-4c3a-be85-0d35ccda6050",
  "Updated": "2024-10-24T07:56:57.2780367+00:00",
  "UpdatedBy": "d65b177c-35cf-4d98-9106-3edc39792d9a",
  "TeamMembers": "sample string 15",
  "LastComment": "sample string 16",
  "LastCommentDate": "2024-10-24T07:56:57.2780367+00:00",
  "LastCommentByID": "a4160f29-9bb0-41f9-a385-4100ba416d96",
  "LastCommentBy": "sample string 17",
  "EndDateChanges": 1,
  "IncludeSurveys": true,
  "AncestorType": 1,
  "Draft": true,
  "LinkedToID": "e4fd61b0-faf6-4e38-9556-23e2642a3469",
  "TeamMemberList": [
    {
      "TaskID": "0bd39d83-2e7f-431c-a446-f3d4511a99d0",
      "IndividualID": "1be11178-23db-4b69-a752-357f8f77ad44",
      "RoleID": "ed7be881-c5ed-4078-bc12-f75d55a6be48",
      "HoursProjected": 1.0,
      "HoursActual": 1.0,
      "ID": "d6ad8448-7488-4bc5-9c6e-ab66c080caa4",
      "RoleName": "sample string 1",
      "HoursActualRollup": 1.0,
      "HoursProjectedRollup": 1.0,
      "IndividualFullName": "sample string 2",
      "Created": "2024-10-24T07:56:57.2780367+00:00",
      "CreatedBy": "44387e42-baa6-4f64-b3b4-53ccc375a05b",
      "SiteID": "815aa2f2-a099-445b-af63-fa9b5ee948a2",
      "Updated": "2024-10-24T07:56:57.2780367+00:00",
      "UpdatedBy": "234dad33-f200-402e-a7d7-df2cfca8b215",
      "IndividualFullOrderedName": "sample string 3",
      "RoleDescription": "sample string 4",
      "TeamSurvey": true
    },
    {
      "TaskID": "0bd39d83-2e7f-431c-a446-f3d4511a99d0",
      "IndividualID": "1be11178-23db-4b69-a752-357f8f77ad44",
      "RoleID": "ed7be881-c5ed-4078-bc12-f75d55a6be48",
      "HoursProjected": 1.0,
      "HoursActual": 1.0,
      "ID": "d6ad8448-7488-4bc5-9c6e-ab66c080caa4",
      "RoleName": "sample string 1",
      "HoursActualRollup": 1.0,
      "HoursProjectedRollup": 1.0,
      "IndividualFullName": "sample string 2",
      "Created": "2024-10-24T07:56:57.2780367+00:00",
      "CreatedBy": "44387e42-baa6-4f64-b3b4-53ccc375a05b",
      "SiteID": "815aa2f2-a099-445b-af63-fa9b5ee948a2",
      "Updated": "2024-10-24T07:56:57.2780367+00:00",
      "UpdatedBy": "234dad33-f200-402e-a7d7-df2cfca8b215",
      "IndividualFullOrderedName": "sample string 3",
      "RoleDescription": "sample string 4",
      "TeamSurvey": true
    }
  ],
  "StatusName": "sample string 18",
  "StatusRank": 1,
  "PhaseName": "sample string 19",
  "PhaseRank": 1,
  "ColorName": "sample string 20",
  "ColorRank": 1,
  "LinkedAncestorID": "4192b7b8-fafc-4339-a961-2c8bcf99cf47",
  "LinkedToName": "sample string 21",
  "LinkedToRowType": 1,
  "LinkedAncestorName": "sample string 22",
  "RowType": 1,
  "RankPath": "QEA=",
  "OnTime": true,
  "CanRead": true,
  "CanUpdate": true,
  "CanDelete": true,
  "CanDelegate": true,
  "NearHighlight": 1
}

Name	Description
ID `globally unique identifier` Required on Update ID of the project.	`globally unique identifier` Required on Update ID of the project.
ParentID `globally unique identifier` ID of the parent.	`globally unique identifier` ID of the parent.
AncestorID `globally unique identifier` Required Ancestor ID of the project; organization or department..	`globally unique identifier` Required Ancestor ID of the project; organization or department..
Rank `integer` Rank of the project.	`integer` Rank of the project.
Color `string` Hex value of the color for the project. (Max length 6 characters)	`string` Hex value of the color for the project. (Max length 6 characters)
HoursActual `decimal number` (Deprecated) Number of hours this project actually took to complete.	`decimal number` (Deprecated) Number of hours this project actually took to complete.
HoursProjected `decimal number` (Deprecated) Number of hours this project is projected to take.	`decimal number` (Deprecated) Number of hours this project is projected to take.
StartDateActual `string` Actual start date of the project.	`string` Actual start date of the project.
StartDateProjected `string` Projected start date of the project.	`string` Projected start date of the project.
EndDateActual `string` Date the project actually ended.	`string` Date the project actually ended.
EndDateProjected `string` Date the project is projected to end.	`string` Date the project is projected to end.
TrackingLabel `string` Customizable label for project.	`string` Customizable label for project.
NearHighlightOverride `integer` Near due highlight settings for a given project that have been overridden at the project level.	`integer` Near due highlight settings for a given project that have been overridden at the project level.
Name `string` Name of the given project. (Max length 255 characters)	`string` Name of the given project. (Max length 255 characters)
Description `string` Description of the project.	`string` Description of the project.
StatusID `integer` ID of the status linked to this project.	`integer` ID of the status linked to this project.
PhaseID `integer` Required ID of the phase linked to this project.	`integer` Required ID of the phase linked to this project.
AncestorName `string` ReadOnly Ancestor Name of the project; department or organization.	`string` ReadOnly Ancestor Name of the project; department or organization.
RankOrder `string` ReadOnly RankOrder to sort rank in the format .0001.0001.0001	`string` ReadOnly RankOrder to sort rank in the format .0001.0001.0001
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	`integer` ReadOnly Number of indent levels, Ex: 1 = 1, 1.1 = 2, 1.1.1 = 3
SumHoursActual `decimal number` ReadOnly Sum of all the hours spent on this project.	`decimal number` ReadOnly Sum of all the hours spent on this project.
SumHoursProjected `decimal number` ReadOnly Sum of the projected number of hours to be spent on this project.	`decimal number` ReadOnly Sum of the projected number of hours to be spent on this project.
Status `string` ReadOnly Name of the status linked to this project.	`string` ReadOnly Name of the status linked to this project.
Phase `string` ReadOnly Name of the phase linked to this project.	`string` ReadOnly Name of the phase linked to this project.
Deleted `boolean` ReadOnly Deleted status of this project.	`boolean` ReadOnly Deleted status of this project.
DeletedByRef `boolean` ReadOnly Deleted by reference status of this project.	`boolean` ReadOnly Deleted by reference status of this project.
Created `string` ReadOnly Date the project was created.	`string` ReadOnly Date the project was created.
CreatedBy `globally unique identifier` ReadOnly ID of the person that created the project.	`globally unique identifier` ReadOnly ID of the person that created the project.
Updated `date` ReadOnly Date the given project was last updated.	`date` ReadOnly Date the given project was last updated.
UpdatedBy `globally unique identifier` ReadOnly ID of the person that last updated the given project.	`globally unique identifier` ReadOnly ID of the person that last updated the given project.
TeamMembers `string` ReadOnly Individuals assigned to the project as team members.	`string` ReadOnly Individuals assigned to the project as team members.
LastComment `string` ReadOnly Last comment made on this project.	`string` ReadOnly Last comment made on this project.
LastCommentDate `date` ReadOnly Date the last comment was made.	`date` ReadOnly Date the last comment was made.
LastCommentByID `globally unique identifier` ReadOnly ID of the person that made the last comment.	`globally unique identifier` ReadOnly ID of the person that made the last comment.
LastCommentBy `string` ReadOnly Name of the person that last commented.	`string` ReadOnly Name of the person that last commented.
EndDateChanges `integer` ReadOnly Number of times the end date has changed for the project.	`integer` ReadOnly Number of times the end date has changed for the project.
IncludeSurveys `boolean` ReadOnly Parameter to include or omit surveys.	`boolean` ReadOnly Parameter to include or omit surveys.
AncestorType `integer` ReadOnly AncestorType of the project.	`integer` ReadOnly AncestorType of the project.
Draft `boolean` Indicates if the given project is a draft, this defaults to false. (drafts are unfinished projects that are only visible to the person that created them and not public).	`boolean` Indicates if the given project is a draft, this defaults to false. (drafts are unfinished projects that are only visible to the person that created them and not public).
LinkedToID `globally unique identifier` ReadOnly ID of the linked project.	`globally unique identifier` ReadOnly ID of the linked project.
TeamMemberList `Collection of TeamMember` ReadOnly List and details of Team Members for a given project.	`Collection of TeamMember` ReadOnly List and details of Team Members for a given project.
StatusName `string` ReadOnly Name of the status for the given project.	`string` ReadOnly Name of the status for the given project.
StatusRank `integer` ReadOnly Rank of the status for the given project.	`integer` ReadOnly Rank of the status for the given project.
PhaseName `string` ReadOnly Name of the phase for the given project.	`string` ReadOnly Name of the phase for the given project.
PhaseRank `integer` ReadOnly Rank of the phase for the given project.	`integer` ReadOnly Rank of the phase for the given project.
ColorName `string` ReadOnly Name of the color for the given project.	`string` ReadOnly Name of the color for the given project.
ColorRank `integer` ReadOnly Rank of the color for the given project.	`integer` ReadOnly Rank of the color for the given project.
LinkedAncestorID `globally unique identifier` ReadOnly Ancestor ID of the linked project.	`globally unique identifier` ReadOnly Ancestor ID of the linked project.
LinkedToName `string` ReadOnly Name of the linked project.	`string` ReadOnly Name of the linked project.
LinkedToRowType `integer` ReadOnly RowType of the linked project.	`integer` ReadOnly RowType of the linked project.
LinkedAncestorName `string` ReadOnly Name of the linked Ancestor.	`string` ReadOnly Name of the linked Ancestor.
EndDate `string` ReadOnly Actual end date of the project, if it is not set then projected end date of the project.	`string` ReadOnly Actual end date of the project, if it is not set then projected end date of the project.
StartDate `string` ReadOnly Actual start date of the project, if it is not set then the projected start date of the given project.	`string` ReadOnly Actual start date of the project, if it is not set then the projected start date of the given project.
RowType `integer` ReadOnly Row type of the given project.	`integer` ReadOnly Row type of the given project.
RankPath `Collection of byte` ReadOnly Current rank of the given project in a byte array.	`Collection of byte` ReadOnly Current rank of the given project in a byte array.
OnTime `boolean` ReadOnly Indicates the on time status of the project, by comparing the actual and projected end dates.	`boolean` ReadOnly Indicates the on time status of the project, by comparing the actual and projected end dates.
CanRead `boolean` ReadOnly Read permission of the given project for the currently logged in individual.	`boolean` ReadOnly Read permission of the given project for the currently logged in individual.
CanUpdate `boolean` ReadOnly Update permission of the given project for the currently logged in individual.	`boolean` ReadOnly Update permission of the given project for the currently logged in individual.
CanDelete `boolean` ReadOnly Delete permission of the given project for the currently logged in individual.	`boolean` ReadOnly Delete permission of the given project for the currently logged in individual.
CanDelegate `boolean` ReadOnly Delegate permission of the given project for the currently logged in individual.	`boolean` ReadOnly Delegate permission of the given project for the currently logged in individual.
NearHighlight `integer` Required Near due highlight settings for a given project that have not been overridden.	`integer` Required Near due highlight settings for a given project that have not been overridden.