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 / getProject

Operation Information

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

Description

This flowcode operation gets details of the specified project.

Request Parameters

The getProject 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 project id.
returnBpmDetails xs:boolean No Determines if related business process details are returned. Default is false.

Response Parameters

Name Type Description
outcome xs:string The outcome of the flowcode operation.
projectDetails xs:string A JSON string of project details.
projectBpmDetails xs:string A JSON string of business process details.
projectRiskWeighting xs:integer The project's risk weighting.
projectTotalCost xs:decimal The total project cost.
projectPermissions xs:string A JSON string of permissions for the user for the specified project (if they exist).

Code Examples

In This Document