1. API
  2. REST API
  3. REST API Endpoint Reference
  4. Project Milestones

Project Milestones

Project milestones are reference points in your project life cycle that marks a significant event or goal the to be completed as part of a project. It includes information about the work to be done, when, by whom, and at what cost.

Note:

The /project-milestones/ endpoint can only be used for project task records with the task classification field set to Milestone in OpenAir. This is equivalent to records with the classification property set to M in the project_task table, or in the XML API Projecttask or SOAP API oaProjecttask datatypes.

For Tasks — project task records with zero duration and the task classification field set to Milestone in OpenAir, or the classification property set to T in the project_task table, or in the XML API Projecttask or SOAP API oaProjecttask datatypes — see Project Tasks.

For Phases — project task records that have other project tasks nested under and the task classification field set to Phase in OpenAir, or the classification property set to P in the project_task table, or in the XML API Projecttask or SOAP API oaProjecttask datatypes — see Project Phases.

Available methods

ProjectMilestone Object Properties

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. It includes information about the work to be done, when, by whom, and at what cost.

The ProjectMilestone object has the following properties:

Name

Description

Type

Read-Only

Query Allowed

Sorting Allowed

attachments

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

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

Yes

—

—

calculatedStarts

Calculated start date of the project milestone. 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.

string($date)

Yes

Yes

—

created

Time the record was created.

string($date-time)

Yes

Yes

Yes

currency

Currency for the money fields in the record. This should be the same as the project currency.

string

Yes

Yes

Yes

customerId

The ID of the associated customer.

integer($int64)

Yes

Yes

Yes

defaultCategory

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

string

—

Yes

Yes

defaultCategory1

A feature, if enabled, would assign this default_category_1 to the category_1 for many transactions that have a category_1_id and project_task_id by searching the project_task and project work breakdown structure for the first default_category_1 defined.

string

—

Yes

Yes

defaultCategory2

A feature, if enabled, would assign this default_category_1 to the category_1 for many transactions that have a category_1_id and project_task_id by searching the project_task and project work breakdown structure for the first default_category_1 defined.

string

—

Yes

Yes

defaultCategory3

A feature, if enabled, would assign this default_category_1 to the category_1 for many transactions that have a category_1_id and project_task_id by searching the project_task and project work breakdown structure for the first default_category_1 defined.

string

—

Yes

Yes

defaultCategory4

A feature, if enabled, would assign this default_category_1 to the category_1 for many transactions that have a category_1_id and project_task_id by searching the project_task and project work breakdown structure for the first default_category_1 defined.

string

—

Yes

Yes

defaultCategory5

A feature, if enabled, would assign this default_category_1 to the category_1 for many transactions that have a category_1_id and project_task_id by searching the project_task and project work breakdown structure for the first default_category_1 defined.

string

—

Yes

Yes

externalId

If the record was imported from an external system you store the unique external record ID here.

string

—

Yes

Yes

id

Unique ID. Automatically assigned by the system

integer($int64)

Yes

Yes

Yes

idNumber

User-defined milestone ID.

integer($int64)

—

Yes

Yes

isClosed

A 1/0 field indicating if this is closed milestone.

Boolean

—

Yes

Yes

isNonBillable

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

Boolean

—

Yes

Yes

name

Short description of this milestone.

string

—

Yes

Yes

notes

Notes associated with the project milestone.

string

—

Yes

Yes

parentId

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

integer($int64)

—

Yes

Yes

predecessors

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

string

Yes

Yes

—

predecessorsLag

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

string

Yes

Yes

—

predecessorsType

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

string

Yes

Yes

—

priority

The priority of the milestone (1 - 9).

integer($int64)

—

Yes

Yes

projectId

The ID of the associated project.

integer($int64)

Yes

Yes

Yes

projectTaskTypeId

The ID of the associated projecttask_type. Not for milestones.

integer($int64)

—

Yes

Yes

seq

The sequence number of this task.

integer($int64)

Yes

Yes

Yes

startDate

Optional scheduled starting date of this task. Overrides computed date Start_date.

string($date)

—

Yes

Yes

updated

Time the record was last updated or modified

string($date-time)

Yes

Yes

Yes

useAllCanAssign

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

Boolean

—

Yes

Yes