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!
-
{{resultItem.title}}
{{resultItem.url}}
{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}
{{docApp.libraryHomeViewProduct.description}}
{{group.title || group.id}}
{{group.description}}
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
curl -X POST 'https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.projectmanager/Projects' \
-H 'Authorization: ESP-APIKEY yourHornbillAPIKey' \
-H 'Content-Type: application/json' \
-d '{"@service":"apps/com.hornbill.projectmanager/Projects","@method":"updateProjectSettings","params":{"projectId":1,"enableScopeChanges":false,"enableBoards":false,"enableResources":false,"enableRelationships":false,"enableBudgets":false,"enableCosts":false,"enableRisks":false,"enableAssumptions":false,"enableIssues":false,"enableDependencies":false,"enableRagTolerances":false,"enableEmails":false,"enableDocuments":false,"enableAttachments":false,"enableLinks":false,"enableTags":false,"logicAutomaticallyCalculateRagStatus":false,"logicRagStatusMatrixId":1,"logicAutomaticallyCalculateProjectCosts":false,"logicAutomaticallyAuditProjectRisks":false,"timesheetProjectCategoryId":1,"timesheetProjectSubCategoryId":1,"timesheetProjectTaskCategoryId":1,"timesheetProjectTaskSubCategoryId":1,"timesheetProjectRiskCategoryId":1,"timesheetProjectRiskSubCategoryId":1}}'
package main
import (
"fmt"
apiLib "github.com/hornbill/goApiLib"
)
func main() {
hornbillAPI := apiLib.NewXmlmcInstance("yourinstanceid")
hornbillAPI.SetAPIKey("yourHornbillAPIKey")
hornbillAPI.SetJSONResponse(true)
hornbillAPI.SetParam("projectId", "xs:integer")
hornbillAPI.SetParam("enableScopeChanges", "xs:boolean")
hornbillAPI.SetParam("enableBoards", "xs:boolean")
hornbillAPI.SetParam("enableResources", "xs:boolean")
hornbillAPI.SetParam("enableRelationships", "xs:boolean")
hornbillAPI.SetParam("enableBudgets", "xs:boolean")
hornbillAPI.SetParam("enableCosts", "xs:boolean")
hornbillAPI.SetParam("enableRisks", "xs:boolean")
hornbillAPI.SetParam("enableAssumptions", "xs:boolean")
hornbillAPI.SetParam("enableIssues", "xs:boolean")
hornbillAPI.SetParam("enableDependencies", "xs:boolean")
hornbillAPI.SetParam("enableRagTolerances", "xs:boolean")
hornbillAPI.SetParam("enableEmails", "xs:boolean")
hornbillAPI.SetParam("enableDocuments", "xs:boolean")
hornbillAPI.SetParam("enableAttachments", "xs:boolean")
hornbillAPI.SetParam("enableLinks", "xs:boolean")
hornbillAPI.SetParam("enableTags", "xs:boolean")
hornbillAPI.SetParam("logicAutomaticallyCalculateRagStatus", "xs:boolean")
hornbillAPI.SetParam("logicRagStatusMatrixId", "xs:integer")
hornbillAPI.SetParam("logicAutomaticallyCalculateProjectCosts", "xs:boolean")
hornbillAPI.SetParam("logicAutomaticallyAuditProjectRisks", "xs:boolean")
hornbillAPI.SetParam("timesheetProjectCategoryId", "xs:integer")
hornbillAPI.SetParam("timesheetProjectSubCategoryId", "xs:integer")
hornbillAPI.SetParam("timesheetProjectTaskCategoryId", "xs:integer")
hornbillAPI.SetParam("timesheetProjectTaskSubCategoryId", "xs:integer")
hornbillAPI.SetParam("timesheetProjectRiskCategoryId", "xs:integer")
hornbillAPI.SetParam("timesheetProjectRiskSubCategoryId", "xs:integer")
responseBody, apiError := hornbillAPI.Invoke("apps/com.hornbill.projectmanager/Projects", "updateProjectSettings")
if apiError != nil {
fmt.Println(apiError)
return
}
fmt.Println(responseBody)
}
const endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.projectmanager/Projects";
const payload = {
"@service": "apps/com.hornbill.projectmanager/Projects",
"@method": "updateProjectSettings",
"params": {
"projectId": 1,
"enableScopeChanges": false,
"enableBoards": false,
"enableResources": false,
"enableRelationships": false,
"enableBudgets": false,
"enableCosts": false,
"enableRisks": false,
"enableAssumptions": false,
"enableIssues": false,
"enableDependencies": false,
"enableRagTolerances": false,
"enableEmails": false,
"enableDocuments": false,
"enableAttachments": false,
"enableLinks": false,
"enableTags": false,
"logicAutomaticallyCalculateRagStatus": false,
"logicRagStatusMatrixId": 1,
"logicAutomaticallyCalculateProjectCosts": false,
"logicAutomaticallyAuditProjectRisks": false,
"timesheetProjectCategoryId": 1,
"timesheetProjectSubCategoryId": 1,
"timesheetProjectTaskCategoryId": 1,
"timesheetProjectTaskSubCategoryId": 1,
"timesheetProjectRiskCategoryId": 1,
"timesheetProjectRiskSubCategoryId": 1
}
};
fetch(endpoint, {
method: 'POST',
headers: {
"Authorization": "ESP-APIKEY yourHornbillAPIKey"
},
body: JSON.stringify(payload)
}).then(res => res.json())
.then(res => console.log(res));
const axios = require('axios');
const endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.projectmanager/Projects";
const payload = {
"@service": "apps/com.hornbill.projectmanager/Projects",
"@method": "updateProjectSettings",
"params": {
"projectId": 1,
"enableScopeChanges": false,
"enableBoards": false,
"enableResources": false,
"enableRelationships": false,
"enableBudgets": false,
"enableCosts": false,
"enableRisks": false,
"enableAssumptions": false,
"enableIssues": false,
"enableDependencies": false,
"enableRagTolerances": false,
"enableEmails": false,
"enableDocuments": false,
"enableAttachments": false,
"enableLinks": false,
"enableTags": false,
"logicAutomaticallyCalculateRagStatus": false,
"logicRagStatusMatrixId": 1,
"logicAutomaticallyCalculateProjectCosts": false,
"logicAutomaticallyAuditProjectRisks": false,
"timesheetProjectCategoryId": 1,
"timesheetProjectSubCategoryId": 1,
"timesheetProjectTaskCategoryId": 1,
"timesheetProjectTaskSubCategoryId": 1,
"timesheetProjectRiskCategoryId": 1,
"timesheetProjectRiskSubCategoryId": 1
}
};
const axiosConfig = {
headers: {
"Authorization": "ESP-APIKEY yourHornbillAPIKey"
}
};
axios.post(endpoint, payload, axiosConfig)
.then((res) => {
console.log("RESPONSE RECEIVED: ", res);
})
.catch((err) => {
console.log("AXIOS ERROR: ", err);
})
$endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.projectmanager/Projects";
$payload = (object) [
'@service' => 'apps/com.hornbill.projectmanager/Projects',
'@method' => 'updateProjectSettings',
'params' => (object) [
'projectId' => 'xs:integer',
'enableScopeChanges' => 'xs:boolean',
'enableBoards' => 'xs:boolean',
'enableResources' => 'xs:boolean',
'enableRelationships' => 'xs:boolean',
'enableBudgets' => 'xs:boolean',
'enableCosts' => 'xs:boolean',
'enableRisks' => 'xs:boolean',
'enableAssumptions' => 'xs:boolean',
'enableIssues' => 'xs:boolean',
'enableDependencies' => 'xs:boolean',
'enableRagTolerances' => 'xs:boolean',
'enableEmails' => 'xs:boolean',
'enableDocuments' => 'xs:boolean',
'enableAttachments' => 'xs:boolean',
'enableLinks' => 'xs:boolean',
'enableTags' => 'xs:boolean',
'logicAutomaticallyCalculateRagStatus' => 'xs:boolean',
'logicRagStatusMatrixId' => 'xs:integer',
'logicAutomaticallyCalculateProjectCosts' => 'xs:boolean',
'logicAutomaticallyAuditProjectRisks' => 'xs:boolean',
'timesheetProjectCategoryId' => 'xs:integer',
'timesheetProjectSubCategoryId' => 'xs:integer',
'timesheetProjectTaskCategoryId' => 'xs:integer',
'timesheetProjectTaskSubCategoryId' => 'xs:integer',
'timesheetProjectRiskCategoryId' => 'xs:integer',
'timesheetProjectRiskSubCategoryId' => 'xs:integer',
]
];
$headers = [
'Authorization: ESP-APIKEY yourHornbillAPIKey',
'Content-Type: application/json'
];
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_URL, $endpoint);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($payload));
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
$resp = curl_exec($curl);
curl_close($curl);
echo $resp;
$Endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.projectmanager/Projects"
$Body = @{
"@service" = "apps/com.hornbill.projectmanager/Projects"
"@method" = "updateProjectSettings"
params = @{
projectId = "xs:integer"
enableScopeChanges = "xs:boolean"
enableBoards = "xs:boolean"
enableResources = "xs:boolean"
enableRelationships = "xs:boolean"
enableBudgets = "xs:boolean"
enableCosts = "xs:boolean"
enableRisks = "xs:boolean"
enableAssumptions = "xs:boolean"
enableIssues = "xs:boolean"
enableDependencies = "xs:boolean"
enableRagTolerances = "xs:boolean"
enableEmails = "xs:boolean"
enableDocuments = "xs:boolean"
enableAttachments = "xs:boolean"
enableLinks = "xs:boolean"
enableTags = "xs:boolean"
logicAutomaticallyCalculateRagStatus = "xs:boolean"
logicRagStatusMatrixId = "xs:integer"
logicAutomaticallyCalculateProjectCosts = "xs:boolean"
logicAutomaticallyAuditProjectRisks = "xs:boolean"
timesheetProjectCategoryId = "xs:integer"
timesheetProjectSubCategoryId = "xs:integer"
timesheetProjectTaskCategoryId = "xs:integer"
timesheetProjectTaskSubCategoryId = "xs:integer"
timesheetProjectRiskCategoryId = "xs:integer"
timesheetProjectRiskSubCategoryId = "xs:integer"
}
}
$Header = @{
"Authorization" = "ESP-APIKEY yourHornbillAPIKey"
}
$Parameters = @{
Method = "POST"
Uri = $Endpoint
Headers = $Header
Body = ($Body | ConvertTo-Json)
ContentType = "application/json"
}
Invoke-RestMethod @Parameters
import requests
import json
endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.projectmanager/Projects"
headers = {
"Authorization": "ESP-APIKEY yourHornbillAPIKey"
}
payload={
"@service":"apps/com.hornbill.projectmanager/Projects",
"@method":"updateProjectSettings",
"params":{
"projectId":"xs:integer",
"enableScopeChanges":"xs:boolean",
"enableBoards":"xs:boolean",
"enableResources":"xs:boolean",
"enableRelationships":"xs:boolean",
"enableBudgets":"xs:boolean",
"enableCosts":"xs:boolean",
"enableRisks":"xs:boolean",
"enableAssumptions":"xs:boolean",
"enableIssues":"xs:boolean",
"enableDependencies":"xs:boolean",
"enableRagTolerances":"xs:boolean",
"enableEmails":"xs:boolean",
"enableDocuments":"xs:boolean",
"enableAttachments":"xs:boolean",
"enableLinks":"xs:boolean",
"enableTags":"xs:boolean",
"logicAutomaticallyCalculateRagStatus":"xs:boolean",
"logicRagStatusMatrixId":"xs:integer",
"logicAutomaticallyCalculateProjectCosts":"xs:boolean",
"logicAutomaticallyAuditProjectRisks":"xs:boolean",
"timesheetProjectCategoryId":"xs:integer",
"timesheetProjectSubCategoryId":"xs:integer",
"timesheetProjectTaskCategoryId":"xs:integer",
"timesheetProjectTaskSubCategoryId":"xs:integer",
"timesheetProjectRiskCategoryId":"xs:integer",
"timesheetProjectRiskSubCategoryId":"xs:integer",
},
}
response = requests.request("POST", endpoint, json=payload, headers=headers)
print(response.text)
- Version {{docApp.book.version}}
- Node {{docApp.node}} / {{docApp.build}}
In This Document