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

Operation Information

  • Application Reference: com.hornbill.projectmanager
  • Scope: Entity - ProjectRisks
  • Class: Entity
  • Required Privilege Level: user
  • Required Rights: Group F - canViewProjectRisks

Description

This flowcode operation gets details of all project risks for the project provided.

Request Parameters

The getProjectRisks 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.
searchFilter xs:string No Search criteria for project risks.
filterByStatus xs:string No Filters the results by a valid status value, e.g. status.noImpact
rowStart xs:integer Yes Row Start for Paging
rowLimit xs:integer Yes Page Size.
sortDirection xs:string No Either ASC or DESC. Required if sortng by risk, status or weighting, otherwise the filter will not apply.
sortOnRisk xs:boolean No Sorts the result set by risk name rather than risk index. Default is false.
sortOnStatus xs:boolean No Sorts the result set by risk status rather than risk index. Default is false.
sortOnWeighting xs:boolean No Sorts the result set by risk weighting rather than risk index. Default is false.

Response Parameters

Name Type Description
outcome xs:string The outcome of the flowcode operation.
totalRecordCount xs:integer The total number of project risks that match the specified project.
projectRisks xs:string A JSON string of project risks.

Code Examples

In This Document