Scribd
Upload
2 views2 pages

API Documentation Bordered

The document outlines API endpoints for uploading attachments and reports to tasks and projects, including methods for deleting and editing reports. Each endpoint specifies the required HTTP method, request body format, expected responses, and potential error messages. The operations include uploading files, deleting reports, and renaming reports with appropriate error handling for various scenarios.

Uploaded by

himavarsha710
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
2 views2 pages

API Documentation Bordered

The document outlines API endpoints for uploading attachments and reports to tasks and projects, including methods for deleting and editing reports. Each endpoint specifies the required HTTP method, request body format, expected responses, and potential error messages. The operations include uploading files, deleting reports, and renaming reports with appropriate error handling for various scenarios.

Uploaded by

himavarsha710
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd

Attachments

Upload Task File

URL /task/:taskId

Method POST

Description Upload attachment to task

Header Content-Type: multipart/form-data

Request Body { "userId": "string", "file": "binary" }

Response { "message": "File uploaded successfully",


"task": { ... } }

Error { "message": "No file uploaded / Task not


found / Server Error" }

Attachments

Upload Project Report

URL /project/:projectId

Method POST

Description Upload report to project

Header Content-Type: multipart/form-data

Request Body { "userId": "string", "file": "binary" }

Response { "message": "Report uploaded


successfully", "project": { ... } }

Error { "message": "No file uploaded / Project not


found / Server Error" }

Project

Delete Report
URL /project/:projectId/report/:reportId

Method DELETE

Description Delete a report

Header Content-Type: application/json

Request Body {}

Response { "project": { ...updated project... } }

Error { "message": "Project not found / Server


error" }

Project

Edit Report

URL /project/:projectId/report/:reportId

Method PUT

Description Rename report

Header Content-Type: application/json

Request Body { "filename": "new_name.pdf" }

Response { "project": { ...updated project... } }

Error { "message": "Project not found / Report


not found / Server error" }

You might also like