Risks - Get by ID
Retrieve a specific risk item by its UUID.
GET /risks/:uuid
Request Headers |
Authorization: Bearer <token> |
Path Parameters |
uuid: string (required) - UUID of the risk item |
Success Response |
HTTP/1.1 200 OK { "risk": { // risk item details } } |
Error Response |
HTTP/1.1 404 Not Found { "error": { "status": 404, "code": "not-found" } } |
Risks - Get by Tenant
Retrieve a list of risks associated with a specific tenant.
GET /risks/tenants/:tenantId
Request Headers |
Authorization: Bearer <token> |
Path Parameters |
tenantId: string (required) - ID of the tenant |
Success Response |
HTTP/1.1 200 OK { "risks": [ { // risk item details }, ... ] } |
Risks - Get by Project
Retrieve a list of risks associated with a specific project.
GET /risks/projects/:projectId
Request Headers |
Authorization: Bearer <token> |
Path Parameters |
projectId: string (required) - ID of the project |
Success Response |
HTTP/1.1 200 OK { "risks": [ { // risk item details }, ... ] } |
Risks - Create
Create a new risk item.
POST /risks
Request Headers |
Authorization: Bearer <token> |
Request Body |
{ "risk": { "project": { "tenant": { "uuid": "string" }, "uuid": "string" }, "name": "string", "state": "raised,monitoring,closed,convertedtoissue", "probability": number, "impact": number, "dateRaised": "ISO 8601 date, e.g. 2001-01-01T00:00:00.000Z", "triggerDate": "ISO 8601 date, e.g. 2001-01-01T00:00:00.000Z", "description": "string", "responsePlanNotes": "string", "responseStrategy": "string", "responseState": "string", "tagList": [ { "name": "string" }, ... ], "owners": [ { "uuid": "string", "email": "string", "name": "string" }, ... ], "isPrivate": boolean } } |
Success Response |
HTTP/1.1 201 Created { "risk": { // risk item details } } |
Error Response |
HTTP/1.1 400 Bad Request { "errors": [ { // error details }, ... ] } |
Risks - Replace
Replace an existing risk item with a new one.
PUT /risks/:uuid
Request Headers |
Authorization: Bearer <token> |
Path Parameters |
uuid: string (required) - UUID of the risk item to replace |
Request Body |
{ "risk": { // updated risk item details } } |
Success Response |
HTTP/1.1 200 OK { "risk": { // updated risk item details } } |
Error Response |
HTTP/1.1 400 Bad Request { "errors": [ { // error details }, ... ] } |
Risks - Partial Update
Update an existing risk item with new values.
PATCH /risks/:uuid
Request Headers |
Authorization: Bearer <token> |
Path Parameters |
uuid: string (required) - UUID of the risk item to update |
Request Body |
{ "risk": { // updated risk item details } } |
Success Response |
HTTP/1.1 200 OK { "risk": { // updated risk item details } } |
Error Response |
HTTP/1.1 400 Bad Request { "errors": [ { // error details }, ... ] } |
Risks - Delete to Recycle Bin
Delete a risk item.
DELETE /risks/:uuid
Request Headers |
Authorization: Bearer <token> |
Path Parameters |
uuid: string (required) - UUID of the risk item to delete |
Success Response |
HTTP/1.1 204 No Content |
Error Response |
HTTP/1.1 404 Not Found { "error": { "status": 404, "code": "not-found" } } |
Risks - Delete Batch
Delete multiple risk items in a batch.
POST /risks/batch-delete
Request Headers |
Authorization: Bearer <token> |
Request Body |
{ "uuids": [ "string", ... ] } |
Success Response |
HTTP/1.1 204 No Content |
Error Response |
HTTP/1.1 404 Not Found { "error": { "status": 404, "code": "not-found" } } |
Risks - Delete Permanently
Hard delete a risk item.
DELETE /risks/:uuid/harddelete
Request Headers |
Authorization: Bearer <token> |
Path Parameters |
uuid: string (required) - UUID of the risk item to hard delete |
Success Response |
HTTP/1.1 204 No Content |
Error Response |
HTTP/1.1 404 Not Found { "error": { "status": 404, "code": "not-found" } } |
Risks - Restore
Restore a previously deleted risk item.
POST /risks/:uuid/restore
Request Headers |
Authorization: Bearer <token> |
Path Parameters |
uuid: string (required) - UUID of the risk item to restore |
Success Response |
HTTP/1.1 200 OK { "risk": { // restored risk item details } } |
Error Response |
HTTP/1.1 404 Not Found { "error": { "status": 404, "code": "not-found" } } |
Risks - Notes - Get by ID
Get a specific note of a risk item.
GET /risks/:riskId/notes/:noteId
Request Headers |
Authorization: Bearer <token> |
Path Parameters |
riskId: string (required) - UUID of the risk item |
noteId: string (required) - UUID of the note |
Success Response |
HTTP/1.1 200 OK { "note": { // note details } } |
Error Response |
HTTP/1.1 404 Not Found { "error": { "status": 404, "code": "not-found" } } |
Risks - Convert to Issue
Converts a risk to an issue.
POST /risks/:riskId/convert
Request Headers |
Authorization: Bearer <token> |
Path Parameters |
riskId: string (required) |
Success Response |
HTTP/1.1 201 Created { "issues": [ // Array of created issue objects ] } |
Error Response |
HTTP/1.1 404 Not Found { "error": { "status": 404, "code": "not-found" } } |
Risks - Convert to Issue - Batch
Converts a batch of risks to issues.
POST /risks/batch-convert
Request Headers |
Authorization: Bearer <token> |
Request Body |
{ "riskUuid": ["riskId1", "riskId2", ...] } |
Success Response |
HTTP/1.1 201 Created { "issues": [ // Array of created issue objects ] } |
Error Response |
HTTP/1.1 404 Not Found { "error": { "status": 404, "code": "not-found" } } |