Submit request in JIRA API with multiline value

[Rajeev Ranjan]

I want my issue description in formatted way so passing multiline value in JIRA API request but it throws error as BAD Request. What is best way to handle this?

{
    "fields": {
       "project": { "key": "TES" },
       "summary": "This is user story",
       "description": "As a 
                       I want   
                       So that  
 Acceptance Criteria: 
 When 
Invoke browser with url
 And
Enter text ABC in field User ID.
 And
Enter password 1234 in field Password 
 And
Click On Submit",
       "issuetype": { "name": "Story" },
       "priority":{ "name":"High" }
   }
} 

[Bill Sheboy · Accepted solution]

Hi @Rajeev Ranjan 

Have you tried to put in new-line \n characters, or other escaped formatting?

Best regards,

Bill

[Rajeev Ranjan]

yes and still says Bad request.

[Bill Sheboy]

Per this article, that should work:

https://confluence.atlassian.com/jirakb/how-to-insert-a-new-line-when-using-lines-the-jira-core-rest-api-779160736.html

Would you please post what you are trying with the newline included?

[Rajeev Ranjan]

I got solution. This packet was coming from different source and description value was having '\n" character but it was throwing Bad request but when I changed that value as "\\n" then it started working. Thanks

[hobweger]

Hi @Rajeev Ranjan , I believe you need to submit the description as an ADF (Atlassian Document Format) object, see https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/.

So for `description`, you'd need to submit something like