| GET | /api/risks/riskmatrices | Query for Coruson Risk Matrices |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ReportId | query | Guid | No | Optional. When supplied, only risk matrices configured/available for this report are returned. |
| OrderBy | query | MatrixOrder | Yes | Property to order by in Ascending order. Default is 'Name'.Allowable Values
|
| OrderByDesc | query | MatrixOrder | Yes | Property to order by in Descending order.Allowable Values
|
| ThenBy | query | MatrixOrder | Yes | Second Property to order by in Ascending order. NOTE: If this value is the same as either the OrderBy or OrderByDesc values, then it will be ignored.Allowable Values
|
| ThenByDesc | query | MatrixOrder | Yes | Second Property to order by in Descending order. NOTE: If this value is the same as either the OrderBy or OrderByDesc values, then it will be ignored.Allowable Values
|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Skip | form | Integer | No | Number of items to skip before returning results. Minimum suitable value is 0 and is also the default value. |
| Take | form | Integer | No | Number of items to return per page. Must be a number in the range 1-100. Default value is 100. |
| OrderBy | form | Enum | No | Order By |
| OrderByDesc | form | Enum | No | Order By Descending |
| ThenBy | form | Enum | No | Then By |
| ThenByDesc | form | Enum | No | Then By Descending |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Version | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RiskMatrices | form | List<RiskMatrix> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TotalResults | form | int | No | |
| Skip | form | int | No | |
| Take | form | int | No | |
| Links | form | List<Link> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StatusDescription | form | string | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | No | |
| RequestUrl | form | string | No | |
| Method | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MatrixRevisionId | form | Guid | No | |
| MatrixId | form | Guid | No | |
| Name | form | string | No | |
| Description | form | string | No | |
| Revision | form | int | No | |
| Status | form | MatrixStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /xml/reply/GetRiskMatrices HTTP/1.1
Host: platform.gaelenlighten.com
Content-Type: application/xml
Content-Length: length
<GetRiskMatrices xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Version>0</Version>
<Skip>0</Skip>
<Take>0</Take>
<OrderBy>Default</OrderBy>
<OrderByDesc>Default</OrderByDesc>
<ThenBy>Default</ThenBy>
<ThenByDesc>Default</ThenByDesc>
<ReportId>00000000-0000-0000-0000-000000000000</ReportId>
</GetRiskMatrices>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetRiskMatricesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<StatusDescription>String</StatusDescription>
<ResponseStatus>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StackTrace>String</StackTrace>
<Errors>
<ResponseError>
<ErrorCode>String</ErrorCode>
<FieldName>String</FieldName>
<Message>String</Message>
<Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</Meta>
</ResponseError>
</Errors>
<Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</Meta>
</ResponseStatus>
<TotalResults>0</TotalResults>
<Skip>0</Skip>
<Take>0</Take>
<Links>
<Link>
<Name>String</Name>
<RequestUrl>String</RequestUrl>
<Method>String</Method>
</Link>
</Links>
<RiskMatrices>
<RiskMatrix>
<MatrixRevisionId>00000000-0000-0000-0000-000000000000</MatrixRevisionId>
<MatrixId>00000000-0000-0000-0000-000000000000</MatrixId>
<Name>String</Name>
<Description>String</Description>
<Revision>0</Revision>
<Status>Draft</Status>
</RiskMatrix>
</RiskMatrices>
</GetRiskMatricesResponse>