Documentation

{{docApp.title}}

{{docApp.description}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

Entity API / updateProjectSettings

Operation Information

  • Application Reference: com.hornbill.projectmanager
  • Scope: Entity - Projects
  • Class: Entity
  • Required Privilege Level: user
  • Required Rights: Group E - canUpdateProjects

Description

This flowcode operation updates an existing project's settings. Only the project manager of the specified project can update these settings.

Request Parameters

The updateProjectSettings API takes the following input parameters. It is important to note that the parameters must satisfy the requirement of the input validation checks.

Name Type Required Description
projectId xs:integer Yes The primary key of the project.
enableScopeChanges xs:boolean No Whether or not the scope changes tab is available for the specified project.
enableBoards xs:boolean No Whether or not the boards tab is available for the specified project.
enableResources xs:boolean No Whether or not the resources tab is available for the specified project.
enableRelationships xs:boolean No Whether or not the relationships tab is available for the specified project.
enableBudgets xs:boolean No Whether or not the budgets tab is available for the specified project.
enableCosts xs:boolean No Whether or not the costs tab is available for the specified project.
enableRisks xs:boolean No Whether or not the risks tab is available for the specified project.
enableAssumptions xs:boolean No Whether or not the assumptions tab is available for the specified project.
enableIssues xs:boolean No Whether or not the issues tab is available for the specified project.
enableDependencies xs:boolean No Whether or not the dependencies tab is available for the specified project.
enableRagTolerances xs:boolean No Whether or not the rag tolerances tab is available for the specified project.
enableEmails xs:boolean No Whether or not the emails tab is available for the specified project.
enableDocuments xs:boolean No Whether or not the documents tab is available for the specified project.
enableAttachments xs:boolean No Whether or not the attachments tab is available for the specified project.
enableLinks xs:boolean No Whether or not the links tab is available for the specified project.
enableTags xs:boolean No Whether or not the tags tab is available for the specified project.
logicAutomaticallyCalculateRagStatus xs:boolean No Whether or not the rag status is automatically generated based on the values of the rag tolerances for the specified project.
logicRagStatusMatrixId xs:integer No The rag tolerance matrix that is to be used to calculate the rag status for the specified project.
logicAutomaticallyCalculateProjectCosts xs:boolean No Whether or not the total project costs are automatically recorded on a daily basis for the specified project.
logicAutomaticallyAuditProjectRisks xs:boolean No Whether or not the project risks are automatically audited on a daily basis for the specified project.
timesheetProjectCategoryId xs:integer No The default timesheet category id for time recorded against the specified project.
timesheetProjectSubCategoryId xs:integer No The default timesheet sub category id for time recorded against the specified project.
timesheetProjectTaskCategoryId xs:integer No The default timesheet category id for time recorded against project tasks for the specified project.
timesheetProjectTaskSubCategoryId xs:integer No The default timesheet sub category id for time recorded against project tasks for the specified project.
timesheetProjectRiskCategoryId xs:integer No The default timesheet category id for time recorded against project risks for the specified project.
timesheetProjectRiskSubCategoryId xs:integer No The default timesheet sub category id for time recorded against project risks for the specified project.

Response Parameters

Name Type Description
outcome xs:string The outcome of the flowcode operation.

Code Examples

In This Document