V3 Attachment API Migration Document

This document captures the changes in the new Attachment V3 API. 

For all the attachment API's, the file should be passed with a parameter name "input_file" and only one file is allowed per call. 

Include the following Accept header "application/vnd.manageengine.sdp.v3+json" 

 

API Response Comparison 

 

For all operations, affix "http://{sdp_base_url}" at the beginning of the URLs.

Project Attachment 

 

Add Project Attachment

/api/v3/projects/<id>/upload?description=test (PUT) 

Get all the attachments in a project 

/api/v3/projects/<id>/attachments (GET) 

Delete a Project Attachment 

/api/v3/projects/<id>/attachments/<id> (DELETE) 

Download aProject Attachment 

/api/v3/projects/<id>/attachments/<id>/download (GET) 

 

Milestone attachment 

 

Add Milestone Attachment 

/api/v3/projects/<id>/milestones/<id>/upload?description=test (PUT) 

Get all the attachments in a 

Milestone 

/api/v3/projects/<id>/milestones/<id>/attachments (GET) 

Delete a Milestone Attachment 

/api/v3/projects/<id>/milestones/<id>/attachments/<id> (DELETE) 

Download a Milestone Attachment 

/api/v3/projects/<id>/milestones/<id>/attachments/<id>/download (GET) 

 

Request Attachment 

 

Add Request Attachment 

/api/v3/requests/<id>/upload (PUT) 

Get all the attachments in a Request 

/api/v3/requests/<id>/attachments (GET) 

Delete a Request Attachment 

/api/v3/requests/<id>/attachments/<id> (DELETE) 

Download a Request Attachment 

/api/v3/requests/<id>/attachments/<id>/download (GET) 

 

Solution Attachment 

 

Add Solution Attachment 

/api/v3/solutions/<id>/upload (PUT) 

Get all the attachments in a Solution 

/api/v3/solution/<id>/attachments (GET) 

Delete a Solution Attachment 

/api/v3/solutions/<id>/attachments/<id> (DELETE) 

Download a Solution Attachment 

/api/v3/solutions/<id>/attachments/<id>/download (GET) 

 

General Task attachment 

 

Add Task Attachment 

/api/v3/tasks/<id>/upload?description=test (PUT) 

Get all the attachments in a Task 

/api/v3/tasks/<id>/attachments (GET) 

Delete a Task Attachment 

/api/v3/tasks/<id>/attachments/<id> (DELETE) 

Download a Task Attachment 

/api/v3/tasks/<id>/attachments/<id>/download (GET) 

 

 

Module Task Attachment URL formats 

 

Add Task Attachment 

/api/v3/{module_name}/<id>/tasks/<id>/upload?description=test (PUT) 

Get all the attachments in a Task 

/api/v3/{module_name}/<id>/tasks/<id>/attachments (GET) 

Delete a Task Attachment 

/api/v3/{module_name}/<id>/tasks/<id>/attachments/<id> (DELETE) 

Download a Task Attachment 

/api/v3/{module_name}/<id>/tasks/<id>/attachments/<id>/download (GET)