1. APIs
  2. TeamDynamix.Api.Plans.Plan

Contents

Summary

A plan in a project.

Properties

Name Editable? Required? Type Nullable? Summary
TaskCount Int32 The number of tasks associated with the plan.
MyTaskCount Int32 The number of tasks associated with the plan that are assigned to the current user.
IsCheckedOut Boolean Whether the plan is checked out.
AnyNewTaskAssignments Boolean Whether there are any unsaved task assignments in the draft.
CheckedOutDate DateTime The date the plan was checked out.
CheckedOutUID String This field is nullable. The UID of the user who checked out the plan.
CheckedOutFullName String This field is nullable. The full name of the user who checked out the plan.
CheckedOutAppID String This field is nullable. The ID of the application in which the plan is checked out.
CanShiftForward Boolean Whether the plan supports forward shifts.
CurrentVersion Int32 The current version of the plan.
IsBaselined Boolean Whether the plan is baselined.
SelectedBaselineId Int32 The selected baseline of the plan, ranging from 0-10.
Tasks TeamDynamix.Api.Plans.Task[] This field is nullable. The tasks associated with the plan.
DraftID Int32 The ID of the current draft associated with the plan.
ID Int32 The ID of the item.
Title This field is editable through the web API. This field is required. String The title of the item.
Description This field is editable through the web API. String This field is nullable. The description of the item.
StartDateUtc This field is editable through the web API. DateTime The start date of the item.
EndDateUtc This field is editable through the web API. DateTime The end date of the item.
Duration Int32 The duration of the item in terms of absolute days.
DurationString String This field is nullable. The string representation of the duration associated with the item. (Ex: 3 days, 4 weeks, 2 months)
CompletedDateUtc DateTime The completed date of the item.
EstimatedHoursAtCompletion Double The estimated number of hours spent on the task once the task is completed.
ProjectID Int32 The ID of the project containing the item.
ProjectIDEncrypted String This field is nullable. The encrypted ID of the project containing the item.
ProjectName String This field is nullable. The name of the project associated with the item.
CreatedUID String This field is nullable. The UID of the user who created the item.
CreatedFullName String The full name of the user who created the item.
CreatedDate DateTime The date the item was created.
EstimatedHours This field is editable through the web API. Double The estimated hours of the item. Editable if there are no subitems.
EstimatedHoursBaseline Double The baselined estimated hours of the item.
ActualHours Double The accrued hours of the item.
PercentComplete Double The percent complete of the item.
StartDateBaselineUtc DateTime The baselined start date of the item.
EndDateBaselineUtc DateTime The baselined end date of the item.
StoryPoints This field is editable through the web API. Double The story points of the item.
ValuePoints This field is editable through the web API. Double The value points of the item.
RemainingHours Double The remaining hours of the item.
PlanType Int32 The type of the plan associated with the item.
  • 1 = Waterfall Plan
  • 2 = Cardwall
VarianceDays Int32 The variance, in days, between the end date and the end date of the currently-active baseline.