Projects
Gets all the projects for the logged in user.
Select
- Id supports '=' operator
- Name supports '=,!=,CONTAINS' operators
- ProjectGroupId supports '=,!=,CONTAINS,IN' operators
- Description supports '=,!=,CONTAINS' operators
- IsPublicProject supports '=,!=' operators
- IsStrictProject supports '=,!=' operators
- IsRollupProject supports '=,!=' operators
- StartDate supports '=,!=,>,<,>=,<=' operators
- EndDate supports '=,!=,>,<,>=,<=' operators
- StatusId supports '=,!=,CONTAINS' operators
- LayoutId supports '=,!=,CONTAINS' operators
- ViewId supports '=' operator
- Columns that support server-side ORDER BY: Name, Description, StartDate, EndDate, CompletedTime, CreatedTime, ModifiedTime, StatusId
SELECT * FROM Projects WHERE Id = '123456000000039053'
Insert
To create a new Project you can specify the following fields:
- Name
- Description
- ProjectType
- IsPublicProject
- IsRollupProject
- StartDate
- EndDate
- OwnerZpuid
- StatusId
- LayoutId
- BillingMethod
- BudgetType
- BudgetCurrency
- BudgetTrackingMethod
- CostBudgetAmount
- BudgetHourlyBudget
- RatePerHourAmount
- FixedCostAmount
- CostPerHourAmount
- ProjectGroupId
- Tags
- AddedVia
- CopyFrom
To create a new Project specify the following fields:
INSERT INTO Projects (Name, BudgetType, BudgetCurrency, Description)
VALUES ('New Project', 'based_on_project', 'EUR', 'TestDescription 123')
Update
You can use the below query to update a Project:
UPDATE Projects SET StatusId = '460276000000005092', Name = 'New Field Value' WHERE Id = '123456000000039053'
Delete
Projects can be deleted by providing the Id and issuing a DELETE statement.
DELETE FROM Projects WHERE Id = '123456000000039053'
Columns
| Name | Type | ReadOnly | Description |
| Id [KEY] | Long | True |
Project ID. |
| Name | String | False |
Project name. |
| Key | String | True |
Unique key identifier of the project. |
| Description | String | False |
Project description. |
| ProjectType | String | False |
Type of project. The allowed values are active, template. |
| IsPublicProject | Boolean | False |
Indicates if the project is public. |
| IsStrictProject | Boolean | True |
Indicates if the project is strict. |
| IsCompleted | Boolean | True |
Indicates if the project is completed. |
| IsRollupProject | Boolean | False |
Indicates if the project is a rollup project. |
| StartDate | Date | False |
Project start date. |
| EndDate | Date | False |
Project end date. |
| CompletedTime | Datetime | True |
Timestamp of project completion. |
| CreatedTime | Datetime | True |
Timestamp when the project was created. |
| ModifiedTime | Datetime | True |
Timestamp when the project was last modified. |
| Color | String | True |
Project color. |
| PercentComplete | Integer | True |
Completed percentage of the project. |
| BusinessHoursId | Long | True |
Business hours ID associated with the project. |
| OwnerZpuid | Long | False |
ZPUID of the project owner. |
| OwnerZuid | Long | True |
ZUID of the project owner. |
| OwnerFirstName | String | True |
First name of the project owner. |
| OwnerLastName | String | True |
Last name of the project owner. |
| OwnerName | String | True |
Name of the project owner. |
| OwnerFullName | String | True |
Full name of the project owner. |
| OwnerEmail | String | True |
Email address of the project owner. |
| CreatedByZuid | Long | True |
ZUID of the user who created the project. |
| CreatedByZpuid | Long | True |
ZPUID of the user who created the project. |
| CreatedByFirstName | String | True |
First name of the user who created the project. |
| CreatedByLastName | String | True |
Last name of the user who created the project. |
| CreatedByName | String | True |
Name of the user who created the project. |
| CreatedByFullName | String | True |
Full name of the user who created the project. |
| CreatedByEmail | String | True |
Email address of the user who created the project. |
| UpdatedByZuid | Long | True |
ZUID of the user who last updated the project. |
| UpdatedByZpuid | Long | True |
ZPUID of the user who last updated the project. |
| UpdatedByFirstName | String | True |
First name of the user who last updated the project. |
| UpdatedByLastName | String | True |
Last name of the user who last updated the project. |
| UpdatedByName | String | True |
Name of the user who last updated the project. |
| UpdatedByFullName | String | True |
Full name of the user who last updated the project. |
| UpdatedByEmail | String | True |
Email address of the user who last updated the project. |
| StatusId | Long | False |
Status ID of the project. |
| StatusName | String | True |
Status name of the project. |
| StatusColor | String | True |
Color code of the project status. |
| StatusColorHexcode | String | True |
Hex color code of the project status. |
| StatusIsClosedType | Boolean | True |
Indicates if the status is a closed type. |
| LayoutId | Long | False |
Layout ID. |
| LayoutName | String | True |
Layout name. |
| LayoutIsDefault | Boolean | True |
Indicates if the layout is the default layout. |
| LayoutType | String | True |
Layout type. |
| BillingMethod | String | False |
Billing method configured for the project. The allowed values are project_hours, staff_hours, fixed_cost, issue_hours, task_or_issue_hours. |
| BudgetType | String | False |
Budget type configured for the project. The allowed values are none, based_on_project, based_on_milestone, based_on_task, based_on_user. |
| BudgetCurrency | String | False |
Budget currency for the project. |
| BudgetTrackingMethod | String | False |
Tracking method configured for the project. |
| CostBudgetCurrencyCode | String | True |
Currency code of the cost budget. |
| CostBudgetFormattedAmount | String | True |
Formatted amount of the cost budget. |
| CostBudgetAmount | Decimal | False |
Total planned project cost. |
| BudgetHourlyBudget | String | False |
Total hourly budget allocated to the project. |
| RatePerHourCurrencyCode | String | True |
Currency code of the billing rate per hour. |
| RatePerHourFormattedAmount | String | True |
Formatted amount of the billing rate per hour. |
| RatePerHourAmount | Decimal | False |
Billing rate per hour. |
| FixedCostCurrencyCode | String | True |
Currency code of the fixed cost. |
| FixedCostFormattedAmount | String | True |
Formatted amount of the fixed cost. |
| FixedCostAmount | Decimal | False |
Fixed project cost. |
| CostPerHourCurrencyCode | String | True |
Currency code of the cost per hour. |
| CostPerHourFormattedAmount | String | True |
Formatted amount of the cost per hour. |
| CostPerHourAmount | Decimal | False |
Cost per hour. |
| PlannedCostCurrencyCode | String | True |
Currency code of the planned cost. |
| PlannedCostFormattedAmount | String | True |
Formatted amount of the planned cost. |
| PlannedCostAmount | Decimal | True |
Planned project cost. |
| ActualCostCurrencyCode | String | True |
Currency code of the actual cost. |
| ActualCostFormattedAmount | String | True |
Formatted amount of the actual cost. |
| ActualCostAmount | Decimal | True |
Actual project cost. |
| ForecastedCostCurrencyCode | String | True |
Currency code of the forecasted cost. |
| ForecastedCostFormattedAmount | String | True |
Formatted amount of the forecasted cost. |
| ForecastedCostAmount | Decimal | True |
Forecasted project cost. |
| PlannedHours | String | True |
Planned hours for the project. |
| ActualHours | String | True |
Actual hours logged for the project. |
| RemainingHours | String | True |
Remaining hours yet to be completed. |
| ForecastedHours | String | True |
Forecasted hours for the project. |
| ProjectGroupId | String | False |
Project group ID. |
| ProjectGroupName | String | True |
Name of the project group. |
| ProjectGroupType | String | True |
Project group type. |
| TasksOpenCount | Integer | True |
Count of open tasks in the project. |
| TasksClosedCount | Integer | True |
Count of closed tasks in the project. |
| IssuesOpenCount | Integer | True |
Count of open issues in the project. |
| IssuesClosedCount | Integer | True |
Count of closed issues in the project. |
| MilestonesOpenCount | Integer | True |
Count of open milestones in the project. |
| MilestonesClosedCount | Integer | True |
Count of closed milestones in the project. |
| Tags | String | False |
Array of tags associated with the task list. |
| ViewId | Long | True |
Identifier of a custom view to filter projects. |
Pseudocolumns
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description |
| AddedVia | String |
The source from which the project is added. The allowed values are web, api. |
| CopyFrom | Long |
The template ID or existing project ID to copy configuration from. |