Projecttask

A Projecttask object can be:

A project task or a project phase is a work package to be completed as part of a project. It includes information about the work to be done, when, by whom, and at what cost.
A project milestone is a reference point in your project life cycle that marks a significant event or goal the to be completed as part of a project.

Review the Usage Guidelines for the Projecttask object.

—	XML	SOAP	REST	Database table
Object	`Projecttask`	`oaProjecttask`	`ProjectMilestone` `ProjectPhase` `ProjectTask`	`project_task`
Supported Commands	`Add`, `Read`, `Modify`, `Delete`	`add()`, `read()`, `modify()`, `upsert()`, `delete()`	See Project Milestones, Project Phases, and Project Tasks	—

—

XML

SOAP

REST

Database table

Object

Projecttask

oaProjecttask

ProjectMilestone

ProjectPhase

ProjectTask

project_task

Supported Commands

Add, Read, Modify, Delete

add(), read(), modify(), upsert(), delete()

See Project Milestones, Project Phases, and Project Tasks

—

The Projecttask object has the following standard properties:

Note:

Projecttask object properties may also include custom fields. The object type supports the custom equal to read method and the enable_custom read attribute.

XML/SOAP	REST	Database	Description
`all_can_assign`	`useAllCanAssign` (`ProjectMilestone` and `ProjectTask`)	`all_can_assign`	Is everyone able to assign time/expenses to this task.
`assign_user_names`	`userAssignments` (`ProjectTask` only)	—	[Write-only in XML API and SOAP API] A comma separated list of employee nicknames assigned to the task. Must be empty if `is_a_phase` is set to `1`. Used only when adding or modifying objects in the XML API and SOAP API No values are returned when reading project tasks using the XML API or SOAP API. Use project task assignment [`Projecttaskassign`] objects instead.
—	`assignmentCc` (`ProjectTask` only)	—	A comma-delimited list of internal IDs of employees to be copied (Cc) into assignment notification email. Other possible listed values: `-1` — the assignee’s manager. `-2` — the manager of the assignee’s manager. `-3` — the project owner. `-5` — the customer owner.
—	`assignmentCcEmails` (`ProjectTask` only)	—	A comma-delimited lists of additional recipient email addresses to be copied (Cc) into assignment notification email. Used for recipients who are not OpenAir users.
—	`attachments`	—	The attachments associated with this task. Array of internal IDs for attachment objects. Array of `{”id”: <integerValue>}` objects.
`calculated_finishes`	`calculatedFinishes` (`ProjectPhase` and `ProjectTask` only)	`calculated_finishes`	[Read-only] Calculated finish date. See Date Fields
`calculated_starts`	`calculatedStarts`	`calculated_starts`	[Read-only] Calculated start date of the milestone, phase or task. See Date Fields
`classification`	—	`classification`	Calculated, read-only classification of the project task with the following values: 'P' for Phase 'T' for Task 'M' for Milestone
`closed`	`isClosed`	`closed`	A 1/0 field indicating if this is closed task. Additional time can not be booked against closed task.
`cost_centerid`	`costCenterId` (`ProjectTask` only)	`cost_center_id`	The internal ID of the associated cost center
`created`	`created`	`created`	[Read-only] The date the milestone, phase or task was created. See Date Fields
`currency`	`currency`	`currency`	The currency for monetary values in the milestone, phase or task record. Three-letter currency code. Should be the same as the project currency.
`customer_name`	—	`customer.name`	[Read-only] The name of the associated customer.
`customerid`	`customerId`	`customer_id`	The internal ID of the associated customer.
`default_category`	`defaultCategory` (`ProjectMilestone` and `ProjectTask`) `defaultCategoryOnPhase` (`ProjectPhase`)	`default_category`	The category to assign to a timesheet entry assigned to this task. The feature has to be enabled for this assignment to work.
`default_category_<N>` where `<N>` is an integer from `1` to `5`	`defaultCategory<N>` (`ProjectMilestone` and `ProjectTask`) `defaultCategoryOnPhase<N>` (`ProjectPhase`) where `<N>` is an integer from `1` to `5`	`default_category_<N>` where `<N>` is an integer from `1` to `5`	A feature, if enabled, would assign this `default_category_<N>` to the `category_<N>` for many transactions that have a `category_<N>_id` and `project_task_id` by searching the `project_task` and phase work breakdown structure for the first `default_category_<N>` defined
`deleted`	—	`deleted`	A "1/0" field indicating if the record was deleted
`early_finish`	—	`early_finish`	The earliest this task can finish, measured in days from project start. This field is recalculated whenever any project dates, user assignments,or user schedules are changed. See Date Fields.
`early_start`	—	`early_start`	The earliest this task can start, measured in days from project start. This field is recalculated whenever any project dates, user assignments,or user schedules are changed. See Date Fields.
`estimated_hours`	—	`estimated_hours`	If the use task estimating feature is turned on, this field will have the estimated total time the task will take to complete. If zero, no estimating has occurred so the estimate is the same as the plan.
`externalid`	`externalId`	`externalid`	The unique external ID of the milestone, phase or task, if the record was imported from an external system.
`fnlt_date`	`fnltDate` (`ProjectTask` only)	`fnlt_date`	The finish no later than date of the task. The task must be finished by this date. See Date Fields.
—	`hoursRemainingEstimates` (`ProjectTask` only)	—	—
`id`	`id`	`id`	[Read-only] The unique internal identifier of the milestone, phase or task. Assigned by OpenAir.
`id_number`	`idNumber`	`id_number`	User-defined task ID. Value assigned automatically if not set when adding a project task. Must be unique for each `Projecttask` object associated with the same project.
`is_a_phase`	—	`is_a_phase`	A 1/0 field indicating if any other project_tasks have us as a parent.
—	`isReadyForRecognition` (`ProjectPhase` and `ProjectTask` only)	—	Flag 1/0 indicating if phase is ready for recognition
—	`isSignOffRequired` (`ProjectTask` only)	—	—
`manual_task_budget`	`useManualTaskBudget` (`ProjectTask` only)	`manual_task_budget`	If set to 1 then the task budget is manually entered rather than calculated by OpenAir.
`name`	`name`	`name`	[Required] Short description of this task.
`non_billable`	`isNonBillable` (`ProjectMilestone` and `ProjectTask` only)	`non_billable`	If set to 1, this is not billable. This is only applicable for project billing rules.
`notes`	`notes`	`notes`	Notes about the project task.
`parentid`	`parentId`	`parentid`	The internal ID of the immediate ancestor. If zero or null, this is a project-level (top-level) task or phase.
`percent_complete`	`percentComplete` (`ProjectPhase` and `ProjectTask` only)	`percent_complete`	This field is an estimate of the percentage of planned time which has been completed. It has no relation to the real time spent on a task. (A 5-hour task could consume 50 hours of work but still be only 25% complete.)
`planned_hours`	`plannedHours` (`ProjectPhase` and `ProjectTask` only)	`planned_hours`	Total number of hours the task is estimated to require. This is the total amount of time the task should take if worked on continuously by one person with no interruptions. A task with zero planned hours is also known as a milestone.
`predecessors`	`predecessors`	`predecessors`	Comma delimited list of task IDs which must complete before this task can start.
`predecessors_lag`	`predecessorsLag`	`predecessors_lag`	Comma delimited list for task ID:days of lag time for predecessors. Only populated if there is a lag time.
`predecessors_type`	`predecessorsType`	`predecessors_type`	Comma delimited list of task ID:relationship type for predecessors. Only populated if the relationship type is not finish-to-start.
`priority`	`priority`	`priority`	The priority of the task (1 - 9).
`project_name`	—	`project.name`	[Read-only] The name of the associated project.
`projectid`	`projectId`	`projectid`	[Required] The ID of the associated project.
`projecttask_typeid`	`projectTaskTypeId` (`ProjectMilestone` and `ProjectTask` only)	`projecttask_typeid`	The ID of the associated project task type. Not for phases.
`seq`	`seq`	`seq`	The sequence number of this task.
`starts`	`startDate` (`ProjectMilestone` and `ProjectTask` only)	`start_date`	Optional scheduled starting date of this task. Overrides computed date Start_date. See Date Fields.
`task_budget_cost`	`taskBudgetCost` (`ProjectTask` only)	`task_budget_cost`	If task budgeting is enabled, this is the total cost of the task.
`task_budget_revenue`	`taskBudgetRevenue` (`ProjectTask` only)	`task_budget_revenue`	If task budgeting is enabled this is the total projected billing for the task.
—	`taskSplits` (`ProjectTask` only)	—	—
`timetype_filter`	`timetypeFilter` (`ProjectTask` only)	`timetype_filter`	A timetype filter. This will hold a list of the timetypes that are allowed to book time to this task.
`updated`	`updated`	`updated`	[Read-only] Time the record was last updated or modified. See Date Fields.
`use_project_assignment`	`isUsingProjectAssignment` (`ProjectTask` only)	`use_project_assignment`	Flag set to 1 if they are using the project level user assignment. Must not be set to `1` if `is_a_phase` is set to `1`.

XML/SOAP

REST

Database

Description

all_can_assign

useAllCanAssign (ProjectMilestone and ProjectTask)

all_can_assign

Is everyone able to assign time/expenses to this task.

assign_user_names

userAssignments (ProjectTask only)

—

[Write-only in XML API and SOAP API] A comma separated list of employee nicknames assigned to the task. Must be empty if is_a_phase is set to 1.

Used only when adding or modifying objects in the XML API and SOAP API

No values are returned when reading project tasks using the XML API or SOAP API. Use project task assignment [Projecttaskassign] objects instead.

—

assignmentCc (ProjectTask only)

—

A comma-delimited list of internal IDs of employees to be copied (Cc) into assignment notification email.

Other possible listed values:

-1 — the assignee’s manager.
-2 — the manager of the assignee’s manager.
-3 — the project owner.
-5 — the customer owner.

—

assignmentCcEmails (ProjectTask only)

—

A comma-delimited lists of additional recipient email addresses to be copied (Cc) into assignment notification email. Used for recipients who are not OpenAir users.

—

attachments

—

The attachments associated with this task. Array of internal IDs for attachment objects.

Array of {”id”: <integerValue>} objects.

calculated_finishes

calculatedFinishes (ProjectPhase and ProjectTask only)

calculated_finishes

[Read-only] Calculated finish date.

See Date Fields

calculated_starts

calculatedStarts

calculated_starts

[Read-only] Calculated start date of the milestone, phase or task.

See Date Fields

classification

—

classification

Calculated, read-only classification of the project task with the following values:

'P' for Phase
'T' for Task
'M' for Milestone

closed

isClosed

closed

A 1/0 field indicating if this is closed task. Additional time can not be booked against closed task.

cost_centerid

costCenterId (ProjectTask only)

cost_center_id

The internal ID of the associated cost center

created

[Read-only] The date the milestone, phase or task was created.

See Date Fields

currency

The currency for monetary values in the milestone, phase or task record. Three-letter currency code. Should be the same as the project currency.

customer_name

—

customer.name

[Read-only] The name of the associated customer.

customerid

customerId

customer_id

The internal ID of the associated customer.

default_category

defaultCategory (ProjectMilestone and ProjectTask)

defaultCategoryOnPhase (ProjectPhase)

default_category

The category to assign to a timesheet entry assigned to this task. The feature has to be enabled for this assignment to work.

default_category_<N>

where <N> is an integer from 1 to 5

defaultCategory<N> (ProjectMilestone and ProjectTask)

defaultCategoryOnPhase<N> (ProjectPhase)

where <N> is an integer from 1 to 5

default_category_<N>

where <N> is an integer from 1 to 5

A feature, if enabled, would assign this default_category_<N> to the category_<N> for many transactions that have a category_<N>_id and project_task_id by searching the project_task and phase work breakdown structure for the first default_category_<N> defined

deleted

—

deleted

A "1/0" field indicating if the record was deleted

early_finish

—

early_finish

The earliest this task can finish, measured in days from project start. This field is recalculated whenever any project dates, user assignments,or user schedules are changed. See Date Fields.

early_start

—

early_start

The earliest this task can start, measured in days from project start. This field is recalculated whenever any project dates, user assignments,or user schedules are changed. See Date Fields.

estimated_hours

—

estimated_hours

If the use task estimating feature is turned on, this field will have the estimated total time the task will take to complete. If zero, no estimating has occurred so the estimate is the same as the plan.

externalid

externalId

externalid

The unique external ID of the milestone, phase or task, if the record was imported from an external system.

fnlt_date

fnltDate (ProjectTask only)

fnlt_date

The finish no later than date of the task. The task must be finished by this date. See Date Fields.

—

hoursRemainingEstimates (ProjectTask only)

—

id

[Read-only] The unique internal identifier of the milestone, phase or task. Assigned by OpenAir.

id_number

idNumber

id_number

User-defined task ID. Value assigned automatically if not set when adding a project task. Must be unique for each Projecttask object associated with the same project.

is_a_phase

—

is_a_phase

A 1/0 field indicating if any other project_tasks have us as a parent.

—

isReadyForRecognition (ProjectPhase and ProjectTask only)

—

Flag 1/0 indicating if phase is ready for recognition

—

isSignOffRequired (ProjectTask only)

—

manual_task_budget

useManualTaskBudget (ProjectTask only)

manual_task_budget

If set to 1 then the task budget is manually entered rather than calculated by OpenAir.

name

[Required] Short description of this task.

non_billable

isNonBillable (ProjectMilestone and ProjectTask only)

non_billable

If set to 1, this is not billable. This is only applicable for project billing rules.

notes

Notes about the project task.

parentid

parentId

parentid

The internal ID of the immediate ancestor. If zero or null, this is a project-level (top-level) task or phase.

percent_complete

percentComplete (ProjectPhase and ProjectTask only)

percent_complete

This field is an estimate of the percentage of planned time which has been completed. It has no relation to the real time spent on a task. (A 5-hour task could consume 50 hours of work but still be only 25% complete.)

planned_hours

plannedHours (ProjectPhase and ProjectTask only)

planned_hours

Total number of hours the task is estimated to require. This is the total amount of time the task should take if worked on continuously by one person with no interruptions. A task with zero planned hours is also known as a milestone.

predecessors

Comma delimited list of task IDs which must complete before this task can start.

predecessors_lag

predecessorsLag

predecessors_lag

Comma delimited list for task ID:days of lag time for predecessors. Only populated if there is a lag time.

predecessors_type

predecessorsType

predecessors_type

Comma delimited list of task ID:relationship type for predecessors. Only populated if the relationship type is not finish-to-start.

priority

The priority of the task (1 - 9).

project_name

—

project.name

[Read-only] The name of the associated project.

projectid

projectId

projectid

[Required] The ID of the associated project.

projecttask_typeid

projectTaskTypeId (ProjectMilestone and ProjectTask only)

projecttask_typeid

The ID of the associated project task type. Not for phases.

seq

The sequence number of this task.

starts

startDate (ProjectMilestone and ProjectTask only)

start_date

Optional scheduled starting date of this task. Overrides computed date Start_date. See Date Fields.

task_budget_cost

taskBudgetCost (ProjectTask only)

task_budget_cost

If task budgeting is enabled, this is the total cost of the task.

task_budget_revenue

taskBudgetRevenue (ProjectTask only)

task_budget_revenue

If task budgeting is enabled this is the total projected billing for the task.

—

taskSplits (ProjectTask only)

—

timetype_filter

timetypeFilter (ProjectTask only)

timetype_filter

A timetype filter. This will hold a list of the timetypes that are allowed to book time to this task.

updated

[Read-only] Time the record was last updated or modified. See Date Fields.

use_project_assignment

isUsingProjectAssignment (ProjectTask only)

use_project_assignment

Flag set to 1 if they are using the project level user assignment. Must not be set to 1 if is_a_phase is set to 1.

Usage Guidelines

Review the following guidelines:

When reading Projecttask objects with the all method, the limit attribute applies to referenced Project objects instead of Projecttask objects unless the filter or deleted attributes are used. It limits the number of referenced Project objects and not the number of Projecttask objects returned.

The following code sample reads all Projecttask objects associated with the first thousand Project objects.
```
                <Read type="Projecttask" method="all" limit="0,1000"/> 

              
```
To limit the number of Projecttask objects, you can use a different read method or set the filter attribute to all.
Adding or modifying a project task triggers the project recalculation process in OpenAir unless you use the no_recalc attribute (see Add, Update and Upsert Attributes), or unless your company's account is configured never to trigger the project recalculation process in OpenAir when a change is made using the API.
When using the XML API, the Projecttask object element accepts the attribute index. The index attribute value can be any one of the column names in the project_task table. This lets you reference Projecttask objects by the designated index property instead of referencing Projecttask objects by internal ID. If you set the index attribute to id_number, for example, you can reference predecessor tasks [predecessors] by these user-defined task numbers instead of internal IDs. The API looks up and store the internal IDs to the database.

The following code sample looks up the Projecttask objects associated with the same project with id_number set to 123 and abc and stores their internal IDs in the predecessors property for the Projecttask with internal ID 427.
```
                <Modify type="Projecttask">
   <Projecttask index="id_number">
      <id>427</id>
      <predecessors>123,abc</predecessors>
   </Projecttask>
</Modify> 

              
```
You cannot delete a Projecttask object if this object is referenced by an object of any of the following type. Delete any dependent objects first before you delete a Projecttask object.
- ProjecttaskEstimate
- Schedulerequest
- Schedulerequest_item
- Slip
- Task
- Ticket
Note:
You can delete a Projecttask object that is referenced by other Projecttask objects as predecessors.