Actions - Get by ID
Returns a RAID item by its UUID.
Request Parameters |
uuid: The UUID of the RAID item |
Request Headers |
Authorization: Bearer <token> |
Success Response |
HTTP/1.1 200 OK { "action": { // The RAID action object } } |
Error Response |
HTTP/1.1 404 Not Found { "error": { "status": 404, "code": "not-found" } } |
Actions - Get by Tenant
Returns a list of RAID items associated with a specific tenant.
Request Parameters |
tenantId: The ID of the tenant |
Request Headers |
Authorization: Bearer <token> |
Success Response |
HTTP/1.1 200 OK { "actions": [ // Array of RAID action objects ] } |
Error Response |
HTTP/1.1 404 Not Found { "error": { "status": 404, "code": "not-found", "message": "No such tenant, or not authorized" } } |
Actions - Get by Project
Returns a list of RAID items associated with a specific project.
Request Parameters |
projectId: The ID of the project |
Request Headers |
Authorization: Bearer <token> |
Success Response |
HTTP/1.1 200 OK { "actions": [ // Array of RAID action objects ] } |
Error Response |
HTTP/1.1 404 Not Found { "error": { "status": 404, "code": "not-found", "message": "No such tenant or project, or not authorized" } } |
Actions - Create
Creates a new RAID item.
POST /actions
Request Body |
{ "action": { "project": { "tenant": { "uuid": "string" }, "uuid": "string" }, "source": { "uuid": "string" }, "name": "string", "state": "created,assigned,inwork,inreview,done,draft,onhold,delegated,blocked", "importance": number, "dueDate": "ISO 8601 date, e.g. 2001-01-01T00:00:00.000Z", "description": "string", "tagList": ["string"], "owners": [ { "uuid": "string", "email": "string", "name": "string" } ], "isPrivate": boolean } } |
Request Headers |
Authorization: Bearer <token> |
Success Response |
HTTP/1.1 200 OK { "action": { // Action object } } |
Error Response |
HTTP/1.1 404 Not Found { "error": { "status": 404, "code": "not-found" } } |
Actions - Replace
Replaces an existing RAID item with a new item.
PUT /actions/:uuid
Request Parameters |
uuid: The UUID of the RAID item to replace. |
Request Body |
{ "action": { "name": "string", "state": "created,assigned,inwork,inreview,done,draft,onhold,delegated,blocked", "importance": number, "dueDate": "ISO 8601 date, e.g. 2001-01-01T00:00:00.000Z", "description": "string", "tagList": ["string"], "owners": [ { "uuid": "string", "email": "string", "name": "string" } ], "isPrivate": boolean } } |
Request Headers |
Authorization: Bearer <token> |
Success Response |
HTTP/1.1 200 OK { "action": { // Updated Action object } } |
Error Response |
HTTP/1.1 404 Not Found { "error": { "status": 404, "code": "not-found" } } |
Actions - Partial Update
Updates an existing RAID item.
PATCH /actions/:uuid
Request Parameters |
uuid: The UUID of the RAID item to update. |
Request Body |
{ "action": { "name": "string", "state": "created,assigned,inwork,inreview,done,draft,onhold,delegated,blocked", "importance": number, "dueDate": "ISO 8601 date, e.g. 2001-01-01T00:00:00.000Z", "description": "string", "tagList": ["string"], "owners": [ { "uuid": "string", "email": "string", "name": "string" } ], "isPrivate": boolean } } |
Request Headers |
Authorization: Bearer <token> |
Success Response |
HTTP/1.1 200 OK { "action": { // Updated Action object } } |
Error Response |
HTTP/1.1 404 Not Found { "error": { "status": 404, "code": "not-found" } } |
Actions - Delete to Recycle Bin
Soft deletes a RAID item.
DELETE /actions/:uuid
Request Parameters |
uuid: The UUID of the RAID item to delete. |
Request Headers |
Authorization: Bearer <token> |
Success Response |
HTTP/1.1 204 No Content OK |
Error Response |
HTTP/1.1 404 Not Found { "error": { "status": 404, "code": "not-found" } } |
Actions - Delete Batch
Soft deletes multiple RAID items in a batch.
POST /actions/batch-delete
Request Body |
{ "uuids": ["string"] } |
Request Headers |
Authorization: Bearer <token> |
Success Response |
HTTP/1.1 204 No Content OK |
Error Response |
HTTP/1.1 404 Not Found { "error": { "status": 404, "code": "not-found" } } |
Actions - Delete Permanently
Permanently deletes a RAID item.
DELETE /actions/:uuid/harddelete
Request Parameters |
uuid: The UUID of the RAID item to delete. |
Request Headers |
Authorization: Bearer <token> |
Success Response |
HTTP/1.1 204 No Content OK |
Error Response |
HTTP/1.1 404 Not Found { "error": { "status": 404, "code": "not-found" } } |
Actions - Restore
Restores a soft-deleted RAID item and its associated notes.
POST /actions/:uuid/restore
Request Parameters |
uuid: The UUID of the RAID item to restore. |
Request Headers |
Authorization: Bearer <token> |
Success Response |
HTTP/1.1 200 OK { "action": { // Restored Action object } } |
Error Response |
HTTP/1.1 404 Not Found { "error": { "status": 404, "code": "not-found" } } |
Actions - Notes - Get by ID
Retrieves a note for a RAID item by its UUID.
GET /actions/:actionId/notes/:noteId
Request Parameters |
actionId: The ID of the RAID item. |
noteId: The UUID of the note. |
Request Headers |
Authorization: Bearer <token> |
Success Response |
HTTP/1.1 200 OK { "note": { // Note object } } |
Error Response |
HTTP/1.1 404 Not Found { "error": { "status": 404, "code": "not-found" } } |