Decisions - Get by ID
Retrieve a specific decision item by its UUID.
GET /decisions/:uuid
Request Headers |
Authorization: Bearer <token> |
Path Parameters |
uuid: string (required) |
Success Response |
HTTP/1.1 200 OK { "decision": { // Retrieved decision information } } |
Error Response |
HTTP/1.1 404 Not Found { "error": { "status": 404, "code": "not-found" } } |
Decisions - Get by Tenant
Retrieve decisions associated with a specific tenant.
GET /decisions/tenants/:tenantId
Request Headers |
Authorization: Bearer <token> |
Path Parameters |
tenantId: string (required) |
Success Response |
HTTP/1.1 200 OK { "decisions": [ { // Decision 1 }, { // Decision 2 }, ... ] } |
Decisions - Get by Project
Retrieve decisions associated with a specific project.
GET /decisions/projects/:projectId
Request Headers |
Authorization: Bearer <token> |
Path Parameters |
projectId: string (required) |
Success Response |
HTTP/1.1 200 OK { "decisions": [ { // Decision 1 }, { // Decision 2 }, ... ] } |
Decisions - Create
Create a new decision.
POST /decisions/
Request Headers |
Authorization: Bearer <token> |
Request Body |
{ "decision": { "project": { "tenant": { "uuid": "string (required)" }, "uuid": "string (required)" }, "name": "string (required)", "state": "created,decided,inreview,draft,deferred (required)", "importance": "integer (required)", "dueDate": "ISO 8601 date, e.g. 2001-01-01T00:00:00.000Z (optional)", "description": "string (optional)", "decisionMade": "string (optional)", "justification": "string (optional)", "impact": "string (optional)", "decisionMakers": "string (optional)", "tagList": [ { "name": "string (required)" }, ... ], "owners": [ { "uuid": "string (optional)", "email": "string (optional)", "name": "string (optional)" }, ... ], "isPrivate": "boolean (optional)" } } |
Success Response |
HTTP/1.1 200 OK { // Created decision object } |
Decisions - Replace
Update an existing decision.
PUT /decisions/:uuid
Request Headers |
Authorization: Bearer <token> |
Path Parameters |
uuid: string (required) |
Request Body |
{ "decision": { "name": "string (required)", "state": "created,decided,inreview,draft,deferred (required)", "importance": "integer (required)", "dueDate": "ISO 8601 date, e.g. 2001-01-01T00:00:00.000Z (optional)", "description": "string (optional)", "decisionMade": "string (optional)", "justification": "string (optional)", "impact": "string (optional)", "decisionMakers": "string (optional)", "tagList": [ { "name": "string (required)" }, ... ], "owners": [ { "uuid": "string (optional)", "email": "string (optional)", "name": "string (optional)" }, ... ], "isPrivate": "boolean (optional)" } } |
Success Response |
HTTP/1.1 200 OK { // Updated decision object } |
Decisions - Partial Update
Partially update an existing decision.
PATCH /decisions/:uuid
Request Headers |
Authorization: Bearer <token> |
Path Parameters |
uuid: string (required) |
Request Body |
{ "decision": { "name": "string (optional)", "state": "created,decided,inreview,draft,deferred (optional)", "importance": "integer (optional)", "dueDate": "ISO 8601 date, e.g. 2001-01-01T00:00:00.000Z (optional)", "description": "string (optional)", "decisionMade": "string (optional)", "justification": "string (optional)", "impact": "string (optional)", "decisionMakers": "string (optional)", "tagList": [ { "name": "string (required)" }, ... ], "owners": [ { "uuid": "string (optional)", "email": "string (optional)", "name": "string (optional)" }, ... ], "isPrivate": "boolean (optional)" } } |
Success Response |
HTTP/1.1 200 OK { // Updated decision object } |
Decisions - Delete to Recycle Bin
Delete a decision.
DELETE /decisions/:uuid
Request Headers |
Authorization: Bearer <token> |
Path Parameters |
uuid: string (required) |
Success Response |
HTTP/1.1 204 No Content |
Decisions - Delete Batch
Delete multiple decisions in a batch.
POST /decisions/batch-delete
Request Headers |
Authorization: Bearer <token> |
Request Body |
{ "uuids": ["string", ...] } |
Success Response |
HTTP/1.1 204 No Content |
Decisions - Delete Permanently
Permanently delete a decision from the system.
DELETE /decisions/:uuid/harddelete
Request Headers |
Authorization: Bearer <token> |
Path Parameters |
uuid: string (required) |
Success Response |
HTTP/1.1 204 No Content |
Decisions - Restore
Restore a previously deleted decision.
POST /decisions/:uuid/restore
Request Headers |
Authorization: Bearer <token> |
Path Parameters |
uuid: string (required) |
Success Response |
HTTP/1.1 200 OK { "decision": { // Restored decision object } } |
Decisions - Notes - Get by ID
Retrieve a specific note by its ID.
GET /decisions/:decisionId/notes/:noteId
Request Headers |
Authorization: Bearer <token> |
Path Parameters |
decisionId: string (required) noteId: string (required) |
Success Response |
HTTP/1.1 200 OK { "note": { // Note object } } |
Decisions - Options - Get
Retrieve the options for a decision.
GET /decisions/:decisionId/options
Request Headers |
Authorization: Bearer <token> |
Path Parameters |
decisionId: string (required) |
Success Response |
HTTP/1.1 200 OK { "options": [ { // Option object }, ... ] } |
Decisions - Options - Get by ID
Retrieve a specific decision option by its UUID.
GET /decisions/:decisionId/options/:optionId
Request Headers |
Authorization: Bearer <token> |
Path Parameters |
decisionId: string (required) optionId: string (required) |
Success Response |
HTTP/1.1 200 OK { "option": { // Option object } } |
Decisions - Options - Delete Permanently
Permanently delete a decision option from a specific decision.
DELETE /decisions/:decisionId/options/:optionId
Request Headers |
Authorization: Bearer <token> |
Path Parameters |
decisionId: string (required) optionId: string (required) |
Success Response |
HTTP/1.1 204 No Content OK |