Risks
Generate a risk report
Freezes a point-in-time risk assessment snapshot.
Authorization
ApiKeyAuth x-api-key<token>
In: header
Path Parameters
organizationId*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/organizations/string/risks/reports" \ -H "Content-Type: application/json" \ -d '{}'{ "id": "string", "organizationId": "string", "title": "string", "notes": "string", "generatedAt": null, "generatedByUserId": "string", "riskCount": 0, "summary": { "scaleMax": 0, "bands": [ { "label": "string", "min": 0, "max": 0, "color": "string" } ], "inherentMatrix": [ { "likelihood": 0, "impact": 0, "score": 0, "band": { "label": "string", "min": 0, "max": 0, "color": "string" }, "count": 0 } ], "residualMatrix": [ { "likelihood": 0, "impact": 0, "score": 0, "band": { "label": "string", "min": 0, "max": 0, "color": "string" }, "count": 0 } ], "countsByBand": [ { "label": "string", "color": "string", "count": 0 } ], "total": 0, "risksWithControl": 0, "overdue": 0 }, "rows": [ { "key": "string", "title": "string", "category": "string", "ownerUserId": "string", "status": "open", "inherentLikelihood": 0, "inherentImpact": 0, "inherentScore": 0, "inherentBand": { "label": "string", "min": 0, "max": 0, "color": "string" }, "residualLikelihood": 0, "residualImpact": 0, "residualScore": 0, "residualBand": { "label": "string", "min": 0, "max": 0, "color": "string" }, "treatmentStrategy": "untreated", "treatmentRationale": "string", "controlCount": 0, "nextReviewDueAt": null } ], "documentId": "string", "assetId": "string", "dateCreated": null, "dateUpdated": null, "property1": null, "property2": null}