JIRA - Call external webservice and display data on select list custom field

[Venkat Krishnamoorthy]

Hello,

We have an external webservice that returns data in XML format. I need to use the URL to get the data and only display values from a certain element as a list of drop down values on a JIRA custom field.

Can ScriptRunner "Select List Conversion" do this? Or is there another way to do this? 

I would appreciate if someone can provide some lead on this.

Thanks,

Venkat.

[Jonny Carter]

Yup! There's a documented example of hitting the GitHub api at https://scriptrunner.adaptavist.com/latest/jira/behaviours-conversions.html#_walkthrough_external_rest_service.

The Github API returns JSON, but the HTTPBuilder library can parse XML into a nice navigable Groovy object just as well. Indeed, it should do that for you automagically, so that you can simply do something like:

import com.onresolve.scriptrunner.runner.rest.common.CustomEndpointDelegate
import groovy.json.JsonBuilder
import groovy.transform.BaseScript
import groovyx.net.http.ContentType
import groovyx.net.http.HTTPBuilder
import groovyx.net.http.Method

import javax.ws.rs.core.MultivaluedMap
import javax.ws.rs.core.Response

@BaseScript CustomEndpointDelegate delegate

githubRepoQuery(httpMethod: "GET") { MultivaluedMap queryParams -> // <1>

    def rt = [:]
    if (query) {
        def httpBuilder = new HTTPBuilder("https://my.endpoint.com")
        def response = httpBuilder.request(Method.GET, ContentType.JSON) {
            uri.path = "/path/to/call"
            uri.query = [parameter:"value", otherQueryParam: "otherValue"]
            headers."User-Agent" = "My JIRA" // replace with any headers needed by your external API

            response.failure = { resp, reader ->
                log.warn("Failed to query API: " + reader.text)
            }
        }

        def neededElements = response["rootElement"]["desiredChildElement"]
        rt = [
            items: neededElements.collect { element ->
                [
                    value: element.property,
                    html : "<b>${element.'someFriendlyLookingProperty'}</b>"
                    label: element."someOtherProperty",
                ]
            },
            total: response["total_count"],
            footer: "Choose thing... (${neededElements.size()} of ${response["total_count"]} shown...)"
        ]
    }

    return Response.ok(new JsonBuilder(rt).toString()).build();
}

The specifics of what child elements to get and how to get them will vary based on the structure of the XML your external webservice returns. For help figuring out how to navigate the parsed response object, see the HTTPBuilder documentation at https://github.com/jgritman/httpbuilder/wiki. The https://github.com/jgritman/httpbuilder/wiki/Using-XML page may be of particular interest.

[Bjoern Veith]

Hi

I as well look for a. Solution to get the value list of a custom field fed by an external webservice. I know Addons such Elements connect and http fields but I ask myself is there a easier way using a script.

Http fields do the job, but the custom field rendering for the json fields is pretty poor and cannot be changed.