public class

IssueAttachmentsResource

extends Object
java.lang.Object
   ↳ com.atlassian.jira.rest.v2.issue.IssueAttachmentsResource

Class Overview

Issue attachments

Summary

Nested Classes
class IssueAttachmentsResource.JiraAttachmentMultipartConfig  
Public Constructors
IssueAttachmentsResource(JiraAuthenticationContext authContext, AttachmentService attachmentService, AttachmentManager attachmentManager, IssueUpdater issueUpdater, I18nHelper i18n, IssueFinder issueFinder, AttachmentJsonBeanConverter attachmentJsonBeanConverter)
Public Methods
Response addAttachment(String issueIdOrKey, Collection<FilePart> fileParts)
Add one or more attachments to an issue.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public IssueAttachmentsResource (JiraAuthenticationContext authContext, AttachmentService attachmentService, AttachmentManager attachmentManager, IssueUpdater issueUpdater, I18nHelper i18n, IssueFinder issueFinder, AttachmentJsonBeanConverter attachmentJsonBeanConverter)

Public Methods

public Response addAttachment (String issueIdOrKey, Collection<FilePart> fileParts)

Add one or more attachments to an issue.

This resource expects a multipart post. The media-type multipart/form-data is defined in RFC 1867. Most client libraries have classes that make dealing with multipart posts simple. For instance, in Java the Apache HTTP Components library provides a MultiPartEntity that makes it simple to submit a multipart POST.

In order to protect against XSRF attacks, because this method accepts multipart/form-data, it has XSRF protection on it. This means you must submit a header of X-Atlassian-Token: no-check with the request, otherwise it will be blocked.

The name of the multipart/form-data parameter that contains attachments must be "file"

A simple example to upload a file called "myfile.txt" to issue REST-123:

curl -D- -u admin:admin -X POST -H "X-Atlassian-Token: no-check" -F "file=@myfile.txt" http://myhost/rest/api/2/issue/TEST-123/attachments

Parameters
issueIdOrKey the issue that you want to add the attachments to
Returns
  • a JSON representation of the attachments added.