Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

XML / JSON Request Custom Field obtains values from an XML / JSON response via XPath / JSONPath. It enables you to pull and display a list of values from an external system without the need to enter them all manually into Jira or to enter them all into your database.

  1. To add an XML/JSON Request Custom Field, go to Jira Administration > Issues > Custom Fields, and click Add Custom Field.
  2. Select XML / JSON Request Custom Field. Click Next.

    Image Modified

  3. Give a name and description to your field, and click click Create. 
  4. Check Issue screens you want your field to be reflected in, and click click Update.
  5. To configure a created custom field, go to cog wheel menu and click click Configure.
    Image Removed
    Image Added

  6. Configure the default value. To set the field, write 'default' and click Set Default.
  7. To configure custom field settings, click click Edit XML/JSON HTTP Settings.
    Image Removed
    Image Added

  8. Configure the parameters as described in the table below. The following picture shows an example of how you can configure the fields.
    Image Removed
    Image Added

  9. To finish configuration click click Save. Your  Your configuration is ready.


That's it. Now select list custom field is available in your create and edit issue screens.
Image Removed
Image Added


Fields description

For each XML/JSON custom field that you add, there is a set of parameters to configure on the field configuration page. 

Field

Description

URL

URL to the required resource.

For the GET requests it can contain GET parameters.

Basic Auth Username

Username for basic access authentication (optional)

Basic Auth Password 
Password for basic access authentication (optional)
Request Type
An HTTP request type (GET, POST)
HeadersThe operating parameters of an HTTP transaction (available in v2.0.2 and above)
Request Data
Body of the HTTP Post request
XPath or JSON Path
Path for getting values

Proxy port

Port number of a proxy server. Proxy settings are available starting with v1.2.11.

Proxy host

IP address of a proxy server. Proxy settings are available starting with v1.2.11.

Proxy scheme (http or https)

The protocol that defines how messages are formatted and transmitted, and what actions Web servers and browsers should take in response to various commands. Proxy settings are available starting with v1.2.11.

See also

HTTP - Adding XML/JSON Multi Request Custom Field

HTTP - Configuration examples