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 that cannot be selected during a CreateProject API call are not visible on this
data model.
Fields
| Field | Description |
|---|---|
| name string optional | The name of the Project. |
| description string optional | An optional description of the Project |
| folderId uuid optional | The unique identifier of the folder of this project, or null if not assigned. |
| projectAccess ProjectCreateAccessDto optional | If you wish to grant access to this Project to a selected list of people during creation, provide a list of ProjectMembers here. If you do not specify anyone, this Project will be available to only yourself. |
| customerId uuid optional | The unique identifier of the customer for this project, or null if not customer specific |
| managerId uuid optional | The unique identifier of the manager of this project, or null if not assigned. |
| chargeCodeId uuid optional | The unique identifier of the ChargeCode for this Project, if one has been selected. |
| statusId uuid optional | The ProjectStatus chosen for this Project, if one has been selected. |
| priorityId uuid optional | The ProjectPriority level of this Project, if one has been selected. |
| 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. |
| budget double optional | The proposed budget for this Project. |
| 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. |
| template boolean required | True if this Project is a template that will be reused as a framework for future Projects. You can save a Project as a template and reuse it in the future for creating additional Projects. If this Project is a template, set this to true and thistemplate will be available to choose from when creating a new Project within the application. |
| templateId uuid optional | When creating a Project, you can optionally specify a Template to use to construct the Project using a collection of pre-designed Tasks. Specifying a value in the TemplateId field will copy default settings for Tasks from your template Project into the newly created Project. This field does not support custom templates. You must choose from a list of ProjectManager-supplied templates. |
| 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. |
| favorite boolean optional | True if this Project is marked as favorite for current user |