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. This value is set by the system and cannot be set with a CreateProject or changed with an UpdateProject call. |
| 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. |
| folder ProjectFolderDto optional | If this Project is grouped within a ProjectFolder, this contains the ProjectFolder information. |
| status ProjectStatusDto optional | The ProjectStatus chosen for this Project. |
| startDate date optional | The earliest planned or actual start date of tasks on the project. This field is calculated automatically and cannot be changed. |
| endDate date optional | The latest planned or actual finish date of tasks on the project. This field is calculated automatically and cannot be changed. |
| targetDate date 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. |
| plannedStartDate date optional | A calculated field of the estimated date on which this Project is expected to start. This date is calculated based on the earliest estimated start date for a Task within this Project. This value is null if no Tasks have an estimated start date within this Project. |
| plannedFinishDate date optional | A calculated field of the estimated date on which this Project is expected to finish. This date is calculated based on the latest planned finish date for a Task within this Project. This value is null if no Tasks have an estimated finish date within this Project. |
| actualStartDate date optional | A calculated field of the actual date on which this Project started. This date is calculated based on the earliest actual start date for a Task within this Project. This value is null if no Tasks have an actual start date within this Project. |
| actualFinishDate date optional | A calculated field of the actual date on which this Project finished. This date is calculated based on the latest actual finish date for a Task within this Project. This value is null if no Tasks have an actual finish date within this Project. |
| priority ProjectPriorityDto optional | The ProjectPriority level of this Project, if defined. |
| chargeCode ProjectChargeCodeDto optional | The ChargeCode of this Project, if defined. |
| manager ProjectManagerDto optional | Information about the manager of this project, if one has been assigned. |
| customer ProjectCustomerDto optional | Information about the manager of this project, if one has been specified. |
| 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. This field is automatically determined by the system when this Project is modified and cannot be directly changed by the user. |
| createDate date-time required | The timestamp in UTC when the Project was created. This field is automatically determined by the system when this Project is created and cannot be changed by the user. |
| isTemplate boolean required | True if this Project is a template that will be reused as a framework for future Projects. |
| favorite boolean required | True if this Project is marked as favorite for current user |
| members ProjectMemberDto optional | The members of the project |
| fields object optional | Project fields array with values |