org.everit.atlassian.restclient.jiracloud.v3.api

Class IssueAttachmentsApi

java.lang.Object

org.everit.atlassian.restclient.jiracloud.v3.api.IssueAttachmentsApi

public class IssueAttachmentsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
IssueAttachmentsApi(org.everit.http.restclient.RestClient restClient)

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<List<Attachment>>	addAttachment(String issueIdOrKey, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Add attachment

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IssueAttachmentsApi

public IssueAttachmentsApi(org.everit.http.restclient.RestClient restClient)

Method Detail

addAttachment

public io.reactivex.Single<List<Attachment>> addAttachment(String issueIdOrKey,
                                                           Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Add attachment

Adds one or more attachments to an issue. Attachments are posted as multipart/form-data (RFC 1867).

Note that:

• The request must have a X-Atlassian-Token: no-check header, if not it is blocked. See Special headers for more information.
• The name of the multipart/form-data parameter that contains the attachments must be file.

The following example uploads a file called myfile.txt to the issue TEST-123:

curl -D- -u admin:admin -X POST -H "X-Atlassian-Token: no-check" -F "file=@myfile.txt" https://your-domain.atlassian.net/rest/api/3/issue/TEST-123/attachments

Tip: Use a client library. Many client libraries have classes for handling multipart POST operations. For example, in Java, the Apache HTTP Components library provides a MultiPartEntity class for multipart POST operations.

This operation can be accessed anonymously.

Permissions required:

• Browse Projects and Create attachments project permission for the project that the issue is in.
• If issue-level security is configured, issue-level security permission to view the issue.

Parameters:

issueIdOrKey -

The ID or key of the issue that attachments are added to.

(required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<List<Attachment>>