Task class
inherits members from ClientObject
Contains methods and properties that can be used to access the details of the task.
Syntax
CSOM
class Task
JSOM
PS.Task
REST Interface
Supported.
PS.Task
http://contoso.sharepoint.com/sites/pwa/_api/ProjectServer/Projects('projectid')/Tasks('taskid')
Members
✓ - Read Support ✓ʷ - Write Support
Properties
| Name | .NET | JSOM | REST | Type | Description | |
|---|---|---|---|---|---|---|
| ActualCostWorkPerformed | ✓ | ✓ | ✓ | Double | Decimal value | Gets the costs incurred for work already performed by resources on the task to date. |
| ActualDuration | ✓ | ✓ | ✓ | String | Gets the span of active working time that is required to complete a task. | |
| ActualDurationMilliseconds | ✓ | ✓ | Integer | Gets the time interval, expressed in milliseconds, for the span of active working time that is required to complete a task. | ||
| ActualDurationTimeSpan | ✓ | ✓ | TimeSpan | Gets the total time interval for the span of active working time that is required to complete a task. | ||
| ActualOvertimeCost | ✓ | ✓ | ✓ | Double | Gets the costs incurred for overtime work already performed on the task by assigned resources. | |
| ActualOvertimeWork | ✓ | ✓ | ✓ | String | Gets the actual amount of overtime work that has already been performed by resources assigned to the task. | |
| ActualOvertimeWorkMilliseconds | ✓ | ✓ | Integer | Gets the time interval, expressed in milliseconds, for the actual amount of overtime work already performed by resources assigned to the task. | ||
| ActualOvertimeWorkTimeSpan | ✓ | ✓ | TimeSpan | Gets the time interval for the actual amount of overtime work that has already been performed by resources assigned to the task. | ||
| BaselineCost | ✓ | ✓ | ✓ | Double | Gets the total planned cost for the task. | |
| BaselineDuration | ✓ | ✓ | ✓ | String | Gets the original span of time that is planned to complete the task, established at the time of the project baseline. | |
| BaselineDurationMilliseconds | ✓ | ✓ | Integer | Gets the time interval, expressed in milliseconds, for the original span of time that is planned to complete the task, established at the time of the project baseline. | ||
| BaselineDurationTimeSpan | ✓ | ✓ | TimeSpan | Gets the total time interval for the original span of time that is planned to complete the task, established at the time of the project baseline. | ||
| BaselineFinish | ✓ | ✓ | ✓ | DateTime | Gets the planned task completion date that was set at the time that the baseline was saved. | |
| BaselineStart | ✓ | ✓ | ✓ | DateTime | Gets the planned task start date that was set at the time that the baseline was saved. | |
| BaselineWork | ✓ | ✓ | ✓ | String | Gets the total planned person-hours that are scheduled for a task, as established at the time of the project baseline. | |
| BaselineWorkMilliseconds | ✓ | ✓ | Integer | Decimal value | Gets the time interval, expressed in milliseconds, for the total planned person-hours that are scheduled for the task, as established at the time of the project baseline. | |
| BaselineWorkTimeSpan | ✓ | ✓ | TimeSpan | Gets the total time interval for the total planned person-hours that are scheduled for the task, as established at the time of the project baseline. | ||
| BudgetCost | ✓ | ✓ | ✓ | Double | Gets the budget costs for budget cost resources. | |
| BudgetedCostWorkPerformed | ✓ | ✓ | ✓ | Double | Gets the budgeted cost of work that has been performed (BCWP) on the task to date. | |
| BudgetedCostWorkScheduled | ✓ | ✓ | ✓ | Double | Gets the budgeted cost of work that is scheduled (BCWS) for the task. | |
| Contact | ✓ | ✓ | ✓ | String | Gets the name of the individual who is responsible for a task. | |
| CostPerformanceIndex | ✓ | ✓ | ✓ | Double | Gets the ratio of the baseline costs of work that has been performed on the task to the actual costs of work that has been performed, calculated up to the project status date or today's date. | |
| CostVariance | ✓ | ✓ | ✓ | Double | Gets the difference between the baseline cost and the total cost for the task. | |
| CostVarianceAtCompletion | ✓ | ✓ | ✓ | Double | Gets the difference between the baseline cost and the total cost at the completion of the task. | |
| CostVariancePercentage | ✓ | ✓ | ✓ | Integer | Gets the ratio of cost variance (CV) to the budgeted cost of work that has been performed on the task (BCWP), expressed as a percentage. | |
| Created | ✓ | ✓ | ✓ | DateTime | Gets the date and the time when the task was added to the project. | |
| CurrentCostVariance | ✓ | ✓ | ✓ | Double | Gets the difference between the baseline cost and the actual cost of the task to date. | |
| CustomFields | ✓ | ✓ | ✓ | CustomFieldCollection | Gets the collection of custom fields for the task. | |
| DurationVariance | ✓ | ✓ | ✓ | String | Gets the difference between the baseline duration of the task and the total duration, or current estimated duration, of the task. | |
| DurationVarianceMilliseconds | ✓ | ✓ | Integer | Gets the time interval, expressed in milliseconds, of the difference between the baseline duration of the task and the total duration, or current estimated duration, of the task. | ||
| DurationVarianceTimeSpan | ✓ | ✓ | TimeSpan | Gets the total time interval for the difference between the baseline duration of the task and the total duration, or current estimated duration, of the task. | ||
| EarliestFinish | ✓ | ✓ | ✓ | DateTime | Gets the earliest date that the task could possibly finish, based on the early finish dates of predecessor and successor tasks, other constraints, and any leveling delay. | |
| EarliestStart | ✓ | ✓ | ✓ | DateTime | Gets the earliest date that the task could possibly begin, based on the early start dates of predecessor and successor tasks and other constraints. | |
| EstimateAtCompletion | ✓ | ✓ | ✓ | Double | Gets the estimate at completion (EAC) for the task. | |
| FinishSlack | ✓ | ✓ | ✓ | String | Gets the duration between the EarlyFinish date and theLateFinish date. | |
| FinishSlackMilliseconds | ✓ | ✓ | Integer | Gets the time interval, expressed in milliseconds, of planned person-hours scheduled for an assignment, at the time of the project baseline. | ||
| FinishSlackTimeSpan | ✓ | ✓ | TimeSpan | Gets the total time interval of planned person-hours scheduled for an assignment, at the time of the project baseline. | ||
| FinishVariance | ✓ | ✓ | ✓ | String | Gets the time that represents the difference between the baseline finish date of the task and the current finish date. | |
| FinishVarianceMilliseconds | ✓ | ✓ | Integer | Gets the time interval, expressed in milliseconds, of the variance of the finish date of the task. | ||
| FinishVarianceTimeSpan | ✓ | ✓ | TimeSpan | Gets the time interval for the variance of the finish date of the task. | ||
| FixedCostAccrual | ✓ | ✓ | ✓ | FixedCostAccrual | Gets the cost accrual method for how and when fixed costs are to be charged, or accrued, to the cost of the task. | |
| FreeSlack | ✓ | ✓ | ✓ | String | Gets the amount of time that the task can be delayed without delaying successor tasks. | |
| FreeSlackMilliseconds | ✓ | ✓ | Integer | Gets the time interval, expressed in milliseconds, of the amount of time that the task can be delayed without delaying successor tasks. | ||
| FreeSlackTimeSpan | ✓ | ✓ | TimeSpan | Gets the total time interval for the amount of time that the task can be delayed without delaying successor tasks. | ||
| Id | ✓ | ✓ | ✓ | Guid | Gets the GUID of the task. | |
| IgnoreResourceCalendar | ✓ | ✓ | ✓ | Boolean | Gets a value that indicates whether the resource calendar is ignored when scheduling a task. True indicates the calendar is not used. False indicates that both the resource calendar and task calendar (if defined) are used when scheduling the task. | |
| IsCritical | ✓ | ✓ | ✓ | Boolean | Gets a value that indicates whether the timing for the task is critical or whether there can be any slack in the timing. | |
| IsEffortDriven | ✓ | ✓ | ✓ | Boolean | Gets a value that indicates whether the scheduling of the task is effort-driven. | |
| IsExternalTask | ✓ | ✓ | ✓ | Boolean | Gets a value that indicates whether this is a ghost task from another project created by Project Professional. | |
| IsOverAllocated | ✓ | ✓ | ✓ | Boolean | Gets a value that indicates whether the task is overallocated. | |
| IsRecurring | ✓ | ✓ | ✓ | Boolean | Gets a value that indicates whether the task is part of a recurring series. | |
| IsRecurringSummary | ✓ | ✓ | ✓ | Boolean | Gets a value that indicates whether the task is the parent of a recurring series. | |
| IsRolledUp | ✓ | ✓ | ✓ | Boolean | Gets a value that indicates whether information on the subtask Gantt bars is rolled up to the summary task bar. | |
| IsSubProject | ✓ | ✓ | ✓ | Boolean | Gets a value that indicates whether the task represents a subproject. | |
| IsSubProjectReadOnly | ✓ | ✓ | ✓ | Boolean | Gets a value that indicates whether a subproject for this task is read-only. | |
| IsSubProjectScheduledFromFinish | ✓ | ✓ | ✓ | Boolean | Gets a value that indicates whether a subproject for this task is set to schedule from finish. | |
| IsSummary | ✓ | ✓ | ✓ | Boolean | Gets a value that indicates whether the task is a summary task. | |
| LatestFinish | ✓ | ✓ | ✓ | DateTime | Gets the latest date that the task can finish without delaying the finish of the project. | |
| LatestStart | ✓ | ✓ | ✓ | DateTime | Gets the latest date that the task can start without delaying the finish of the project. | |
| LevelingDelay | ✓ | ✓ | ✓ | String | Gets the amount of time that leveling can delay the task from its early start. | |
| LevelingDelayMilliseconds | ✓ | ✓ | Integer | Decimal value | Gets the time interval, expressed in milliseconds, for the amount of time that leveling can delay the task from its early start. | |
| LevelingDelayTimeSpan | ✓ | ✓ | TimeSpan | Gets the time interval for the amount of time that leveling can delay the task from its early start. | ||
| Modified | ✓ | ✓ | ✓ | DateTime | Gets the modified date. | |
| Notes | ✓ | ✓ | ✓ | String | Gets the notes about the task. | |
| OutlinePosition | ✓ | ✓ | ✓ | String | Gets the position of the task in the project outline hierarchy. | |
| OvertimeCost | ✓ | ✓ | ✓ | Double | Gets the total overtime cost for the task. | |
| OvertimeWork | ✓ | ✓ | ✓ | String | Gets the amount of overtime scheduled to be performed on the task. | |
| OvertimeWorkMilliseconds | ✓ | ✓ | Integer | Gets the time interval, expressed in milliseconds, for the amount of overtime scheduled to be performed on the task. | ||
| OvertimeWorkTimeSpan | ✓ | ✓ | TimeSpan | Gets the total time interval for the amount of overtime scheduled to be performed on the task. | ||
| PercentWorkComplete | ✓ | ✓ | ✓ | Integer | Gets the current status of the task, expressed as the percentage of work that has been completed. | |
| PreLevelingFinish | ✓ | ✓ | ✓ | DateTime | Gets the finish date of the task as it was before resource leveling was performed. | |
| PreLevelingStart | ✓ | ✓ | ✓ | DateTime | Gets the start date of the task as it was before resource leveling was performed. | |
| RegularWork | ✓ | ✓ | ✓ | String | Gets the total amount of non-overtime work that is scheduled to be performed on the task. | |
| RegularWorkMilliseconds | ✓ | ✓ | Integer | Gets the time interval, expressed in milliseconds, for the total amount of non-overtime work that is scheduled to be performed on the task. | ||
| RegularWorkTimeSpan | ✓ | ✓ | TimeSpan | Gets the total time interval for the total amount of non-overtime work that is scheduled to be performed on the task. | ||
| RemainingCost | ✓ | ✓ | ✓ | Double | Gets the remaining scheduled expense that will be incurred during completion of the remaining scheduled work on the task. | |
| RemainingOvertimeCost | ✓ | ✓ | ✓ | Double | Gets the remaining scheduled overtime expense for the task. | |
| RemainingOvertimeWork | ✓ | ✓ | ✓ | String | Gets the amount of time, such as person-hours or days, that is required to complete the remaining overtime work for a task. | |
| RemainingOvertimeWorkMilliseconds | ✓ | ✓ | Integer | Gets the time interval, expressed in milliseconds, for the amount of time, such as person-hours or days, that is required to complete the remaining overtime work for a task. | ||
| RemainingOvertimeWorkTimeSpan | ✓ | ✓ | TimeSpan | Gets the total time interval for the amount of time, such as person-hours or days, that is required to complete the remaining overtime work for a task. | ||
| RemainingWork | ✓ | ✓ | ✓ | String | Gets the time, such as person-hours or days, that is required to complete the task or set of tasks. | |
| RemainingWorkMilliseconds | ✓ | ✓ | Integer | Gets the time interval, expressed in milliseconds, for the time, such as person-hours or days, that is required to complete the task or set of tasks. | ||
| RemainingWorkTimeSpan | ✓ | ✓ | TimeSpan | Gets the total time interval for the time, such as person-hours or days, that is required to complete the task or set of tasks. | ||
| Resume | ✓ | ✓ | ✓ | DateTime | Gets the date that the remaining part of the task is scheduled to resume after progress is entered. | |
| ScheduleCostVariance | ✓ | ✓ | ✓ | Double | Gets the difference in cost terms between the current progress and the baseline planned progress for a resource on the task. | |
| ScheduledDuration | ✓ | ✓ | ✓ | String | Gets the total span of active working time for the task as entered or as calculated based on the start date, the finish date, calendars, and other scheduling factors. | |
| ScheduledDurationMilliseconds | ✓ | ✓ | Integer | Gets the time interval, expressed in milliseconds, for the total span of active working time for the task as entered or as calculated based on the start date, the finish date, calendars, and other scheduling factors. | ||
| ScheduledDurationTimeSpan | ✓ | ✓ | TimeSpan | Gets the time interval for the total span of active working time for the task as entered or as calculated based on the start date, the finish date, calendars, and other scheduling factors. | ||
| ScheduledFinish | ✓ | ✓ | ✓ | DateTime | Gets the date when work on the task is scheduled to be complete as it was calculated based on the start date, the duration, dependencies, calendars, and other scheduling factors. | |
| ScheduledStart | ✓ | ✓ | ✓ | DateTime | Gets the date when work on the task is scheduled to begin as it was calculated based on dependencies, constraints, calendars, and other scheduling factors. | |
| SchedulePerformanceIndex | ✓ | ✓ | ✓ | Double | Gets the ratio of the budgeted cost of work performed to the budgeted cost of work scheduled. | |
| ScheduleVariancePercentage | ✓ | ✓ | ✓ | Integer | Gets the ratio of schedule variance (SV) to budgeted cost of work scheduled (BCWS), expressed as a percentage. | |
| StartSlack | ✓ | ✓ | ✓ | String | Gets the duration between the EarlyStart date and theLateStart date. | |
| StartSlackMilliseconds | ✓ | ✓ | Integer | Gets the time interval, expressed in milliseconds, for the duration between the EarlyStart date and theLateStart date. | ||
| StartSlackTimeSpan | ✓ | ✓ | TimeSpan | Gets the time interval for the duration between the EarlyStart date and theLateStart date. | ||
| StartVariance | ✓ | ✓ | ✓ | String | Gets the time that represents the difference between a baseline start date of the task and its currently scheduled start date. | |
| StartVarianceMilliseconds | ✓ | ✓ | Integer | Gets the time interval, expressed in milliseconds, for the variance of the task start date. | ||
| StartVarianceTimeSpan | ✓ | ✓ | TimeSpan | Gets the time interval for the variance of the task start date. | ||
| Stop | ✓ | ✓ | ✓ | DateTime | Gets the date that represents the end of the actual portion of the task. | |
| SubProject | ✓ | ✓ | ✓ | PublishedProject | Gets a project that has been inserted into the master project. | |
| ToCompletePerformanceIndex | ✓ | ✓ | ✓ | Double | Gets the To Complete Performance Index for the task. | |
| TotalSlack | ✓ | ✓ | ✓ | String | Gets the time that the task's finish date can be delayed without delaying the project's finish date. | |
| TotalSlackMilliseconds | ✓ | ✓ | Integer | Gets the time interval, expressed in milliseconds, for the amount of time that the task finish date can be delayed without delaying the project's finish date. | ||
| TotalSlackTimeSpan | ✓ | ✓ | TimeSpan | Gets the total time interval for the amount of time that the task finish date can be delayed without delaying the project's finish date. | ||
| WorkBreakdownStructure | ✓ | ✓ | ✓ | String | Gets a code that identifies a location in a hierarchical structure that is used to organize tasks for reporting schedules and tracking costs. | |
| WorkVariance | ✓ | ✓ | ✓ | String | Gets the difference between baseline work and currently scheduled work on a task, expressed as, for example, the number of person-hours or days. | |
| WorkVarianceMilliseconds | ✓ | ✓ | Integer | Gets the time interval, expressed in milliseconds, for the difference between baseline work and currently scheduled work on the task. | ||
| WorkVarianceTimeSpan | ✓ | ✓ | TimeSpan | Gets the total time interval for the difference between baseline work and currently scheduled work on the task. |