Scriptrunner HTTP Requests and Brackets

Andrew Lipscomb October 23, 2016

So if we look at one of the out-of-box scripts for ScriptRunner Cloud

post('/rest/api/2/issue')
        .header('Content-Type', 'application/json')
        .body(
        [
                fields: [
                        summary    : 'Task Summary',
                        description: "Don't forget to do this!.",
                        project    : [
                                key: projectKey
                        ],
                        issuetype  : [
                                id: taskType
                        ]
                ]
        ])


We see that the JSON brackets that would normally be a curly bracket are now a square bracket.

 

I can't find any standards or documentation around this, so hopefully someone knows:

a) Why a non-standard syntax is used and 

b) How to then show arrays in JSON (where a square bracket would be used normally)

//Rough Custom field array representation; how is this done in Groovy?
customfield_12345: [
	{
		name: "Johnny"
		asset: "Subaru"
	}
	{
		name: "Kate"
		asset: "Holden"
	}
]

1 answer

1 accepted

3 votes
Answer accepted
Jon Mort [Adaptavist]
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.
October 24, 2016

Hi Andrew,

The script uses Groovy map and list notation, which gets converted into JSON rather than JSON directly. 

Your example would be:

customfield_12345: [ // start array
  [ //start object
    name : "Johnny",
    asset: "Subaru"
  ],
  [
    name : "Kate",
    asset: "Holden"
 ]
]

Note that map literals are defined as [key: value] pairs and lists use comma separated lists.

It is possible to use JSON directly (although much less convenient) like so:

post('/rest/api/2/issue')
        .header('Content-Type', 'application/json')
        .body("""
        {
                "fields": {
                        "summary"    : "Task Summary",
                        "description": "Don't forget to do this!.",
                        "project"    : {
                                "key": "${projectKey}"
                        },
                        "issuetype"  : {
                                "id": "${taskType}"
                        }
                }
        }
        """).asString()

Suggest an answer

Log in or Sign up to answer