API v1 ReferenceProjects

Updates the project with the specified id.

Updates the project with the specified id. Special handling for retainer projects: If the project has at least one Retainer, the IsRetainer flag is automatically set to true. For retainer projects, the TimeBudget cannot be set. Instead the TimeBudget is the sum of all retainer budgets.

Required Permissions: The user has to be the creator of the project or needs write permissions of the feature project-master-data.

Path parameters

projectIdUUIDRequired
The id of the project.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
namestringRequired>=0 characters<=1000 characters

The name of the Project. Max allowed length: 1000 characters.

isPrivatebooleanOptional
Whether this is a private project only visible to members and the creator. Defaults to false. Can only be changed from public to private if no times have been tracked on this project. Can always be made public.
descriptionstring or nullOptional>=0 characters<=25000 characters

The project description. Max allowed length: 25000 characters.

startDatedatetime or nullOptional
The start date of the project.
dueDatedatetime or nullOptional
The due date of the project.
companyIdUUID or nullOptional
The id of the company.
timeBudgetinteger or nullOptional
The time budget the project has, in seconds.
isBillableByDefaultboolean or nullOptional
Whether project times should be billable by default.
projectTypeIdUUID or nullOptional
The id of the project type of this project.
colorstring or nullOptional>=0 characters<=14 characters
The color of the project for display purposes in awork. The supported colors are defined by the awork frontend. Can be null when no color assigned.
deductNonBillableHoursbooleanOptional

Whether to deduct non-billable hours from project budgets.

Response

OK
namestring>=0 characters<=1000 characters

The name of the Project. Max allowed length: 1000 characters.

isPrivateboolean or null
Whether this is a private project only visible to members and the creator. Defaults to false. Can only be changed from public to private if no times have been tracked on this project. Can always be made public.
descriptionstring or null>=0 characters<=25000 characters

The project description. Max allowed length: 25000 characters.

startDatedatetime or null
The start date of the project.
dueDatedatetime or null
The due date of the project.
companyIdUUID or null
The id of the company.
timeBudgetinteger or null
The time budget the project has, in seconds.
isBillableByDefaultboolean or null
Whether project times should be billable by default.
projectTypeIdUUID or null
The id of the project type of this project.
colorstring or null>=0 characters<=14 characters
The color of the project for display purposes in awork. The supported colors are defined by the awork frontend. Can be null when no color assigned.
deductNonBillableHoursboolean or null

Whether to deduct non-billable hours from project budgets.

projectStatusIdUUID or null
The id of the project status.
projectTemplateIdUUID or null
The id of the template which is used to create the project.
publicProjectTemplateIdUUID or null
The id of the public template which is used to create the project.
idUUID or null
Id of the project.
hasImageboolean or null
Whether the project has an image.
createdOndatetime or null
The date this entity was created.
createdByUUID or null
The id of the user who created this entity.
updatedOndatetime or null
The date this entity was last modified.
updatedByUUID or null
The id of the user who last modified this entity.
closedOndatetime or null
The date the project was set to closed.
closedByUUID or null
The user who closed the project.
createdByProjectTemplateIdUUID or null
The id of the template the project was created from.
projectTypeobject or null
projectStatusobject or null
companyobject or null
tagslist of objects or null
The tags for this project.
totalPlannedDurationWithHierarchylong or null

The total planned duration of the project with hierarchy, in seconds. Calculated based on the planned durations of tasks and task lists of the project. Sum of Sum(TotalPlannedDurationWithHierarchy of all task lists) and Sum(TotalPlannedDurationWithHierarchy of all parent tasks without list)

tasksCountinteger or null
The number of all tasks related to the project.
tasksDoneCountinteger or null
The number of all tasks in status 'done' related to the project.
memberslist of objects or null
The members of this project.
trackedDurationinteger or null
The summed up duration of all time trackings for this project.
customFieldslist of objects or null
Custom fields of the project.
resourceVersionlong or null
The version of the entity, updated on every modification, to the ticks in UTC. Not identical to UpdatedOn.
teamslist of objects or null
The teams the project is associated to.
isExternalboolean or null

True if this entity is coming from an external workspace (awork Connect).

isRetainerboolean or null
Whether the project is a retainer project. Retainer projects have at least one retainer with budgets.
plannedDurationlong or nullDeprecated
The total planned time of the project, in seconds. The time is calculated as te sum of the planned duration by all project tasks.