projects

Updates the specified project.

Changed on

Updates the specified project's details. Retainer projects derive their time budget from retainer budgets, and changing the description can clear its live-editing document.

         <Check title="Required Permissions" icon="key">The user must be the project creator or have `project-master-data:write` permission.</Check>
put/projects/{projectId}

Request

  • Base URL: https://api.awork.com/api/v1
  • URL: https://api.awork.com/api/v1/projects/{projectId}
  • Auth: HTTP bearer

Path parameters

projectIdstring uuid required

The id of the project.

Request body

namestring required

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

isPrivateboolean

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 nullable

The project description. Max allowed length: 25000 characters.

startDatestring date-time nullable

The start date of the project.

dueDatestring date-time nullable

The due date of the project.

companyIdstring uuid nullable

The id of the company.

timeBudgetinteger nullable

The time budget the project has, in seconds.

isBillableByDefaultboolean nullable

Whether project times should be billable by default.

projectTypeIdstring uuid nullable

The id of the project type of this project.

colorstring nullable

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

Whether to deduct non-billable hours from project budgets.

isProjectKeyVisibleboolean nullable

Whether project key should be visible for this project. If null, it will use the workspace default setting.

Response

OK

namestring required

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

isPrivateboolean

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 nullable

The project description. Max allowed length: 25000 characters.

startDatestring date-time nullable

The start date of the project.

dueDatestring date-time nullable

The due date of the project.

companyIdstring uuid nullable

The id of the company.

timeBudgetinteger nullable

The time budget the project has, in seconds.

isBillableByDefaultboolean nullable

Whether project times should be billable by default.

projectTypeIdstring uuid nullable

The id of the project type of this project.

colorstring nullable

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

Whether to deduct non-billable hours from project budgets.

isProjectKeyVisibleboolean nullable

Whether project key should be visible for this project. If null, it will use the workspace default setting.

projectStatusIdstring uuid

The id of the project status.

projectTemplateIdstring uuid nullable

The id of the template which is used to create the project.

publicProjectTemplateIdstring uuid nullable

The id of the public template which is used to create the project.

workflowIdstring uuid nullable

The id of the workflow to link to the project. Cannot be specified if ProjectTemplateId is set.

idstring uuid

Id of the project.

projectKeystring nullable

The unique project key within the workspace (e.g., "NIKE"). Maximum 32 characters, uppercase letters, numbers, and dashes only.

hasImageboolean

Whether the project has an image.

createdOnstring date-time

The date this entity was created.

createdBystring uuid

The id of the user who created this entity.

updatedOnstring date-time

The date this entity was last modified.

updatedBystring uuid

The id of the user who last modified this entity.

closedOnstring date-time nullable

The date the project was set to closed.

closedBystring uuid nullable

The user who closed the project.

createdByProjectTemplateIdstring uuid nullable

The id of the template the project was created from.

plannedDurationinteger nullable

The total planned time of the project, in seconds. The time is calculated as te sum of the planned duration by all project tasks.

totalPlannedDurationWithHierarchyinteger nullable

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 nullable

The number of all tasks related to the project.

tasksDoneCountinteger nullable

The number of all tasks in status 'done' related to the project.

trackedDurationinteger nullable

The summed up duration of all time trackings for this project.

resourceVersioninteger

The version of the entity, updated on every modification, to the ticks in UTC. Not identical to UpdatedOn.

isExternalboolean

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

isRetainerboolean

Whether the project is a retainer project. Retainer projects have at least one retainer with budgets.

isMultiAssignmentAllowedboolean

Indicates whether multi-assignment is allowed for tasks in this project's workspace.

Changes

  • 1556e0487867Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e46cf415581Revision changes
    • info

      api operation id PutProjectById removed and replaced with projects_PutProjectById