SOLVED: attach a file using REST from scriptrunner

C. Derek Fields
Community Leader
Community Leader
Community Leaders are connectors, ambassadors, and mentors. On the online community, they serve as thought leaders, product experts, and moderators.
June 13, 2019

I have created a very simple test script to figure out how to attach a file to an issue. The "file" is actually just text that I want to create a file. Since this is in the Cloud, I am assuming that I can't write the file to a temp file in order to import it.

import org.apache.http.entity.ContentType;
String text = "This is a simple set of text"


def response = Unirest.post("/rest/api/3/issue/CDFT-1/attachments")
.header("Accept", "application/json")
.header("Content-Type", "text/plain")
.header("X-Atlassian-Token", "no-check")
.field("file", text.getBytes(), "text.txt")
.asJson();

I get a 415 - Unsupported Media Type error from this. Any help is welcome

2 answers

1 accepted

Suggest an answer

Log in or Sign up to answer
7 votes
Answer accepted
C. Derek Fields
Community Leader
Community Leader
Community Leaders are connectors, ambassadors, and mentors. On the online community, they serve as thought leaders, product experts, and moderators.
June 18, 2019

After a lot of experimentation, I was able to successfully attach the file with the following code:

 

String key = 'MP-59'
def newBody = "Here is a text file that I want to attach"

InputStream stream = new ByteArrayInputStream(newBody.getBytes())

def resp = Unirest.post("/rest/api/3/issue/${key}/attachments")
.header("X-Atlassian-Token", "no-check")
.field('file', stream, 'test.txt')
.asJson()

 

The trick was to convert it to a stream so that it could be uploaded by Unirest 

Lukáš Meitner
Contributor
August 15, 2022

Hi Derek,

thanks for the solution, it helped a lot. Unfortunately I have an issue with special characters in Czech language. For example "Č". So that, if I want to write a file with filename "Český jazyk.png", the output filename will be "?esk? jazyk.png". Can you please help me with this issue? I tried to resolve it by myself, but it was unsuccesfull.

Many thanks.

Best regards,

Lukas

1 vote
Peter-Dave Sheehan
Rising Star
Rising Star
Rising Stars are recognized for providing high-quality answers to other users. Rising Stars receive a certificate of achievement and are on the path to becoming Community Leaders.
June 17, 2019

I've never user Unirest ...  or jira-cloud ... but had some issues like that with an actual file and I ended up with something like this using httpBuilder:

def file = new File(filePath)
def
fileEntity = new MultipartEntityBuilder()
fileEntity.addBinaryBody("file", file)

def httpBuilder = new HTTPBuilder(baseUrl)
httpBuilder.request(Method.POST, "/rest/api/latest/issue/$key/attachments"){req ->
headers.Authorization = "myBasicAuthString"
body = fileEntity.build()
}
C. Derek Fields
Community Leader
Community Leader
Community Leaders are connectors, ambassadors, and mentors. On the online community, they serve as thought leaders, product experts, and moderators.
June 18, 2019

Note that I am not attaching an existing file, but a "file" that is simply a text string. Because I am in the Cloud, I can't create the file on disk first and then read it in as a file.

Peter-Dave Sheehan
Rising Star
Rising Star
Rising Stars are recognized for providing high-quality answers to other users. Rising Stars receive a certificate of achievement and are on the path to becoming Community Leaders.
June 18, 2019

I know, I just wanted to provide the example of creating the fileEntity using the multipartEntyBuilder

btw, here is the full class path: 

import org.apache.http.entity.mime.MultipartEntityBuilder

 Looking that up a little, I see that you can do the following:

import org.apache.http.entity.mime.MultipartEntityBuilder
import groovyx.net.http.*

String text = "This is a simple set of text"

def
fileEntity = new MultipartEntityBuilder()
fileEntity.asTextBody("file", text)

def httpBuilder = new HTTPBuilder(baseUrl)
httpBuilder.request(Method.POST, "/rest/api/latest/issue/$key/attachments"){req ->
headers.Authorization = "myBasicAuthString"
body = fileEntity.build()
}
aas
Contributor
May 31, 2021

I  try to do as you @Peter-Dave Sheehan  but I have

Exception : java.lang.IllegalArgumentException: No encoder found for request content type */*

here is code 

def f = new File("/u/app/jira/jira_home/data/attachments/attach1.jpeg")
fileEntity.addBinaryBody("file", f)
def http = new HTTPBuilder("${addressJira}/rest/api/2/issue/TEST-1/attachments")
http.setClient(HttpClients.custom().setDefaultRequestConfig(defaultRequestConfig).build())
try {
http.request(POST) {
headers.'Authorization' = "Basic ${authString}"
headers."X-Atlassian-Token: nocheck"
// if add ContentType.ANY nothing changes
//contentType = ContentType.ANY
body = fileEntity.build()

response.success = { resp, json ->
log.info("Resp status " + resp.status.toString())
}

response.failure = { resp ->
log.warn("response code is : " + resp.status.toString())}
}
} catch (Exception exception) {
log.warn("Exception : " + exception)
}

 

Peter-Dave Sheehan
Rising Star
Rising Star
Rising Stars are recognized for providing high-quality answers to other users. Rising Stars receive a certificate of achievement and are on the path to becoming Community Leaders.
June 1, 2021

Have you tried with

contentType = ContentType.BINARY

 

I have no experience using HTTPBuilder.setClient() methods.

aas
Contributor
June 1, 2021

Yes, I've tried, no luck.

That works

HttpClient httpClient = HttpClientBuilder.create().build()
HttpPost httpPost = new HttpPost("${addressJira}/rest/api/latest/issue/TEST-1013/attachments")
httpPost.setHeader("Authorization", "Basic ${authString}")
httpPost.setHeader("X-Atlassian-Token", "nocheck")
MultipartEntityBuilder entity = MultipartEntityBuilder.create()
entity.addPart("file", new FileBody(file))
httpPost.setEntity(entity.build())
HttpResponse response = httpClient.execute(httpPost)
log.warn(response.statusLine)
Joel Batac
Contributor
August 30, 2023

@Peter-Dave Sheehan - do you have something for oauth authentication?

Peter-Dave Sheehan
Rising Star
Rising Star
Rising Stars are recognized for providing high-quality answers to other users. Rising Stars receive a certificate of achievement and are on the path to becoming Community Leaders.
August 30, 2023

@Joel Batac I'm not a fan of using oauth in scripts. OAuth works well when you want to authorize a custom app to act on behalf of a user. Normally, the source app will direct the user to the target app to authorize the access, then return back to the source app to initiate the real communication.

But in most cases I've encountered in the scriptrunner/jira end of things, I want Jira to own the connection and the users themselves don't have an account on the target system.  In that case, there is no need for an oauth dance. API Bearer Token or Basic Auth is so much simpler.

That being said, it should be possible, but will vary widely based on what system you are attempting to connect to.

In any case, oauth will require multiple HTTP calls. First, you call an authorization endpoint with the client id and secret and some payload (depends on the system). That authorization call should include the access and refresh tokens. And then you can include those tokens in subsequent calls.

TAGS
AUG Leaders

Atlassian Community Events