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 - 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
curl -X POST 'https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.projectmanager/ProjectRisks' \
-H 'Authorization: ESP-APIKEY yourHornbillAPIKey' \
-H 'Content-Type: application/json' \
-d '{"@service":"apps/com.hornbill.projectmanager/ProjectRisks","@method":"getProjectRisks","params":{"projectId":1,"searchFilter":"xs:string","filterByStatus":"xs:string","rowStart":1,"rowLimit":1,"sortDirection":"xs:string","sortOnRisk":false,"sortOnStatus":false,"sortOnWeighting":false}}'
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("searchFilter", "xs:string")
hornbillAPI.SetParam("filterByStatus", "xs:string")
hornbillAPI.SetParam("rowStart", "xs:integer")
hornbillAPI.SetParam("rowLimit", "xs:integer")
hornbillAPI.SetParam("sortDirection", "xs:string")
hornbillAPI.SetParam("sortOnRisk", "xs:boolean")
hornbillAPI.SetParam("sortOnStatus", "xs:boolean")
hornbillAPI.SetParam("sortOnWeighting", "xs:boolean")
responseBody, apiError := hornbillAPI.Invoke("apps/com.hornbill.projectmanager/ProjectRisks", "getProjectRisks")
if apiError != nil {
fmt.Println(apiError)
return
}
fmt.Println(responseBody)
}
const endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.projectmanager/ProjectRisks";
const payload = {
"@service": "apps/com.hornbill.projectmanager/ProjectRisks",
"@method": "getProjectRisks",
"params": {
"projectId": 1,
"searchFilter": "xs:string",
"filterByStatus": "xs:string",
"rowStart": 1,
"rowLimit": 1,
"sortDirection": "xs:string",
"sortOnRisk": false,
"sortOnStatus": false,
"sortOnWeighting": false
}
};
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/ProjectRisks";
const payload = {
"@service": "apps/com.hornbill.projectmanager/ProjectRisks",
"@method": "getProjectRisks",
"params": {
"projectId": 1,
"searchFilter": "xs:string",
"filterByStatus": "xs:string",
"rowStart": 1,
"rowLimit": 1,
"sortDirection": "xs:string",
"sortOnRisk": false,
"sortOnStatus": false,
"sortOnWeighting": false
}
};
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/ProjectRisks";
$payload = (object) [
'@service' => 'apps/com.hornbill.projectmanager/ProjectRisks',
'@method' => 'getProjectRisks',
'params' => (object) [
'projectId' => 'xs:integer',
'searchFilter' => 'xs:string',
'filterByStatus' => 'xs:string',
'rowStart' => 'xs:integer',
'rowLimit' => 'xs:integer',
'sortDirection' => 'xs:string',
'sortOnRisk' => 'xs:boolean',
'sortOnStatus' => 'xs:boolean',
'sortOnWeighting' => 'xs:boolean',
]
];
$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/ProjectRisks"
$Body = @{
"@service" = "apps/com.hornbill.projectmanager/ProjectRisks"
"@method" = "getProjectRisks"
params = @{
projectId = "xs:integer"
searchFilter = "xs:string"
filterByStatus = "xs:string"
rowStart = "xs:integer"
rowLimit = "xs:integer"
sortDirection = "xs:string"
sortOnRisk = "xs:boolean"
sortOnStatus = "xs:boolean"
sortOnWeighting = "xs:boolean"
}
}
$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/ProjectRisks"
headers = {
"Authorization": "ESP-APIKEY yourHornbillAPIKey"
}
payload={
"@service":"apps/com.hornbill.projectmanager/ProjectRisks",
"@method":"getProjectRisks",
"params":{
"projectId":"xs:integer",
"searchFilter":"xs:string",
"filterByStatus":"xs:string",
"rowStart":"xs:integer",
"rowLimit":"xs:integer",
"sortDirection":"xs:string",
"sortOnRisk":"xs:boolean",
"sortOnStatus":"xs:boolean",
"sortOnWeighting":"xs:boolean",
},
}
response = requests.request("POST", endpoint, json=payload, headers=headers)
print(response.text)
- Version {{docApp.book.version}}
- Node {{docApp.node}} / {{docApp.build}}
In This Document