| GET | /api/reports/{ReportId}/riskassessments | Query for the Risk Assessments of a Coruson Report |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ReportId | path | Guid | Yes | The unique identifier of the report to retrieve risk assessments for. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Version | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ReportRiskAssessments | form | List<ReportRiskAssessmentDetail> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StatusDescription | form | string | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | Guid | No | |
| RiskAssessmentValue | form | int | No | |
| SuggestedAction | form | string | No | |
| Comment | form | string | No | |
| PerformedBy | form | string | No | |
| PerformedById | form | Guid | No | |
| PerformedDate | form | string | No | |
| RiskRatingDisplayValue | form | string | No | |
| MatrixName | form | string | No | |
| MatrixDescription | form | string | No | |
| MatrixRevisionNumber | form | int | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /jsv/reply/GetReportRiskAssessments HTTP/1.1
Host: platform.gaelenlighten.com
Content-Type: text/jsv
Content-Length: length
{
Version: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
StatusDescription: String,
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
},
ReportRiskAssessments:
[
{
RiskAssessmentValue: 0,
SuggestedAction: String,
Comment: String,
PerformedBy: String,
PerformedDate: String,
RiskRating: String,
MatrixName: String,
MatrixDescription: String,
MatrixRevisionNumber: 0
}
]
}