A Project is a collection of Tasks that contributes towards a goal. Within a Project, Tasks
represent individual items of work that team members must complete. The sum total of Tasks
within a Project represents the work to be completed for that Project.
Fields
| Field | Description |
|---|---|
| id uuid required | The unique identifier of the Project. |
| name string optional | The name of the Project. |
| description string optional | An optional description of the Project |
| shortCode string optional | A shortened name that will be used when reporting on Projects. This short name can be edited in the Project Settings page within the application and can be any text you wish. |
| shortId string optional | A short identifier that uniquely identifies this Project within your Workspace using a single letter followed by a number. This code can be used for APIs that accept Project unique identifiers. You can observe the short ID within the application by observing the URL of the page you visit when you click on this project. The page's URL will appear in the form https://pm.app.projectmanager.com/project/board/D16 - in thisexample, the ShortId is D16.This code is automatically assigned for you and cannot be changed. |
| startDate date-time optional | The earliest planned or actual start date of tasks on the project. This field is calculated automatically and cannot be changed. |
| endDate date-time optional | The latest planned or actual finish date of tasks on the project. This field is calculated automatically and cannot be changed. |
| targetDate date-time optional | The target planned completion date for this Project, or null if one has not been selected. This value can be updated in the Project Settings page or the Portfolio Project page within the application. |
| budget double optional | The proposed budget for this Project. |
| hourlyRate double optional | The default hourly rate for work on this Project. This rate will be used if an assignee working on this Project does not have an hourly rate configured in their profile. |
| statusUpdate string optional | Contains an optional status update for Projects that can be used to summarize the status of multiple Projects at a glance. You can edit the StatusUpdate field on the Portfolio page of the application. |
| modifyDate date-time required | The timestamp in UTC when the Project was most recently modified. |
| createDate date-time required | The timestamp in UTC when the Project was created. |
| isTemplate boolean required | True if this Project is a template that will be reused as a framework for future Projects. |