Projects - Get by ID
Retrieve a specific project by its UUID.
GET /projects/:uuid
Request Headers |
Authorization: Bearer <token> |
Path Parameters |
uuid: string (required) |
Success Response |
HTTP/1.1 200 OK { "project": { // Project object } } |
Error Response |
HTTP/1.1 404 Not Found { "error": { "status": 404, "code": "not-found", "message": "No such project, or not authorized" } } |
Projects - Get by Tenant
Retrieve projects based on a specific tenant.
GET /projects/tenants/:tenantId
Request Headers |
Authorization: Bearer <token> |
Path Parameters |
tenantId: string (required) |
Query Parameters |
offset: number (optional) |
limit: number (optional) |
Success Response |
HTTP/1.1 200 OK { "projects": [ // Array of project objects ] } |
Error Response |
HTTP/1.1 404 Not Found { "error": { "status": 404, "code": "not-found", "message": "No such tenant, or not authorized" } } |
Projects - Get by Tenant Member
Retrieve projects for a specific tenant and member.
GET /projects/tenants/:tenantId/member/:memberId
Request Headers |
Authorization: Bearer <token> |
Path Parameters |
tenantId: string (required) |
memberId: string (required) |
Success Response |
HTTP/1.1 200 OK { "projects": [ // Array of project objects ] } |
Error Response |
HTTP/1.1 404 Not Found { "error": { "status": 404, "code": "not-found", "message": "No such tenant or member" } } |
Projects - Create
Create a new project.
POST /projects
Request Headers |
Authorization: Bearer <token> |
Request Body |
{ "project": { "tenant": { "uuid": "string" }, "name": "string", "state": "draft,active,onhold,completed,cancelled", "tagList": [ { "name": "string" } ], "description": "string", "dueDate": "ISO 8601 date, e.g. 2001-01-01T00:00:00.000Z", "budget": number } } |
Success Response |
HTTP/1.1 201 Created { "project": { // Created project object } } |
Error Response |
HTTP/1.1 404 Not Found { "error": { "status": 404, "code": "not-found" } } |
Projects - Replace
Update the details of a specific project.
PUT /projects/:uuid
Request Headers |
Authorization: Bearer <token> |
Path Parameters |
uuid: string (required) |
Request Body |
{ "project": { "budget": number, "description": "string", "dueDate": "ISO 8601 date, e.g. 2001-01-01T00:00:00.000Z", "integration_ppmObjectId": "string", "integration_ppmParentId": "string", "name": "string", "state": "draft,active,onhold,completed,cancelled", "tagList": [ { "name": "string" } ] } } |
Success Response |
HTTP/1.1 200 OK { "project": { // Updated project object } } |
Error Response |
HTTP/1.1 404 Not Found { "error": { "status": 404, "code": "not-found" } } |
Projects - Partial Update
Partially update the details of a specific project.
PATCH /projects/:uuid
Request Headers |
Authorization: Bearer <token> |
Path Parameters |
uuid: string (required) |
Request Body |
{ "project": { "budget": number, "description": "string", "dueDate": "ISO 8601 date, e.g. 2001-01-01T00:00:00.000Z", "integration_ppmObjectId": "string", "integration_ppmParentId": "string", "name": "string", "state": "draft,active,onhold,completed,cancelled", "tagList": [ { "name": "string" } ] } } |
Success Response |
HTTP/1.1 200 OK { "project": { // Updated project object } } |
Error Response |
HTTP/1.1 404 Not Found { "error": { "status": 404, "code": "not-found" } } |
Projects - Delete to Recycle Bin
Soft delete a specific project and its associated RAID items.
DELETE /projects/:uuid
Request Headers |
Authorization: Bearer <token> |
Path Parameters |
uuid: string (required) |
Success Response |
HTTP/1.1 204 No Content OK |
Error Response |
HTTP/1.1 404 Not Found { "error": { "status": 404, "code": "not-found" } } |
Projects - Delete Permanently
Permanently delete a specific project.
DELETE /projects/:uuid/harddelete
Request Headers |
Authorization: Bearer <token> |
Path Parameters |
uuid: string (required) |
Success Response |
HTTP/1.1 204 No Content OK |
Error Response |
HTTP/1.1 404 Not Found { "error": { "status": 404, "code": "not-found" } } |
Projects - Restore
Restore a previously deleted project and associated RAID items.
POST /projects/:uuid/restore
Request Headers |
Authorization: Bearer <token> |
Path Parameters |
uuid: string (required) |
Success Response |
HTTP/1.1 200 OK { "project": { // project object } } |
Error Response |
HTTP/1.1 404 Not Found { "error": { "status": 404, "code": "not-found" } } |
Projects - Notes - Get by ID
Get a specific note of a project.
GET /projects/:projectId/notes/:noteId
Request Headers |
Authorization: Bearer <token> |
Path Parameters |
projectId: string (required) |
noteId: string (required) |
Success Response |
HTTP/1.1 200 OK { "note": { // note object } } |
Error Response |
HTTP/1.1 404 Not Found { "error": { "status": 404, "code": "not-found" } } |