Issues - Get by ID
Retrieve a RAID item by its UUID.
GET /issues/{uuid}
Request Headers |
Authorization: Bearer <token> |
Success Response |
HTTP/1.1 200 OK { "issue": { // RAID item details } } |
Error Response |
HTTP/1.1 404 Not Found { "error": { "status": 404, "code": "not-found" } } |
Issues - Get by Tenant
Retrieve RAID items by tenant.
GET /issues/tenants/{tenantId}
Request Headers |
Authorization: Bearer <token> |
Query Parameters |
offset: (optional) integer limit: (optional) integer |
Success Response |
HTTP/1.1 200 OK { "issues": [ // List of RAID items ] } |
Error Response |
HTTP/1.1 401 Unauthorized { // Error details } |
Issues - Get by Project
Retrieve RAID items by project.
GET /issues/projects/{projectId}
Request Headers |
Authorization: Bearer <token> |
Query Parameters |
offset: (optional) integer limit: (optional) integer |
Success Response |
HTTP/1.1 200 OK { "issues": [ // List of RAID items ] } |
Error Response |
HTTP/1.1 401 Unauthorized { // Error details } |
Issues - Create
Create a new RAID item.
POST /issues/
Request Headers |
Authorization: Bearer <token> |
Request Body |
{ "issue": { "name": "string", "state": "created,active,resolved,pendingreview,reviewed,closed,deescalated,escalated", "responseState": "string", "impact": "string", "impactScore": number, "importance": number, "description": "string", "resolution": "string", "rootCause": "string", "dateResolved": "ISO 8601 date, e.g. 2001-01-01T00:00:00.000Z (optional)", "tagList": [ { "name": "string" } ], "owners": [ { "uuid": "string", "name": "string" } ], "project": { "uuid": "string", "tenant": { "uuid": "string" } } } } |
Success Response |
HTTP/1.1 200 OK |
Error Response |
HTTP/1.1 400 Bad Request { // Error details } |
Issues - Replace
Replace an existing RAID item.
PUT /issues/{uuid}
Request Headers |
Authorization: Bearer <token> |
Request Body |
{ "issue": { "name": "string", "state": "created,active,resolved,pendingreview,reviewed,closed,deescalated,escalated", "responseState": "string", "impact": "string", "impactScore": number, "importance": number, "description": "string", "resolution": "string", "rootCause": "string", "dateResolved": "ISO 8601 date, e.g. 2001-01-01T00:00:00.000Z (optional)", "tagList": [ { "name": "string" } ], "owners": [ { "uuid": "string", "name": "string" } ] } } |
Success Response |
HTTP/1.1 200 OK |
Error Response |
HTTP/1.1 400 Bad Request { // Error details } |
Issues - Partial Update
Update an existing RAID item.
PATCH /issues/{uuid}
Request Headers |
Authorization: Bearer <token> |
Request Body |
{ "issue": { "name": "string", "state": "created,active,resolved,pendingreview,reviewed,closed,deescalated,escalated", "responseState": "string", "impact": "string", "impactScore": number, "importance": number, "description": "string", "resolution": "string", "rootCause": "string", "dateResolved": "ISO 8601 date, e.g. 2001-01-01T00:00:00.000Z (optional)", "tagList": [ { "name": "string" } ], "owners": [ { "uuid": "string", "name": "string" } ] } } |
Success Response |
HTTP/1.1 200 OK |
Error Response |
HTTP/1.1 400 Bad Request { // Error details } |
Issues - Delete to Recycle Bin
Soft delete a RAID item.
DELETE /issues/{uuid}
Request Headers |
Authorization: Bearer <token> |
Success Response |
HTTP/1.1 204 No Content |
Error Response |
HTTP/1.1 404 Not Found { // Error details } |
Issues - Delete Batch
Soft deletes multiple RAID items.
POST /issues/batch-delete
Request Headers |
Authorization: Bearer <token> |
Request Body |
{ "uuids": ["string"] } |
Success Response |
HTTP/1.1 204 OK OK |
Error Response |
HTTP/1.1 404 Not Found { "error": { "status": 404, "code": "not-found" } } |
Issues - Delete Permanently
Permanently deletes a RAID item.
DELETE /issues/:uuid/harddelete
Request Headers |
Authorization: Bearer <token> |
Path Parameters |
uuid: string (required) |
Success Response |
HTTP/1.1 204 OK OK |
Error Response |
HTTP/1.1 404 Not Found { "error": { "status": 404, "code": "not-found" } } |
Issues - Restore
Restores a previously deleted RAID item along with its associated notes.
POST /issues/:uuid/restore
Request Headers |
Authorization: Bearer <token> |
Path Parameters |
uuid: string (required) |
Success Response |
HTTP/1.1 200 OK { "issue": { // Restored RAID item information } } |
Error Response |
HTTP/1.1 404 Not Found { "error": { "status": 404, "code": "not-found" } } |
Issues - Notes - Get by ID
Retrieve a specific note for a RAID item by its UUID.
GET /issues/:issueId/notes/:noteId
Request Headers |
Authorization: Bearer <token> |
Path Parameters |
issueId: string (required) noteId: string (required) |
Success Response |
HTTP/1.1 200 OK { "note": { // Retrieved note information } } |
Error Response |
HTTP/1.1 404 Not Found { "error": { "status": 404, "code": "not-found" } } |
Issues - Relate to Risk
Relate an issue to a risk item.
POST /issues/:issueId/relatedtorisk/:riskId
Request Headers |
Authorization: Bearer <token> |
Path Parameters |
issueId: string (required) riskId: string (required) |
Success Response |
HTTP/1.1 200 OK { "issue": { // Updated RAID item information } } |
Error Response |
HTTP/1.1 404 Not Found { "error": { "status": 404, "code": "not-found" } } |
โ