HTTP - Configuration examples
After careful consideration, we have made the decision to retire HTTP Feed Custom Fields. After a few years on the Marketplace, we have seen decreased usage and low interest in this product, making continued development and support not viable.
You may continue using your installed license and we will continue supporting customers with active licenses, but we will no longer release updates through the Atlassian Marketplace. We will archive the app on the Atlassian Marketplace in 90 days, and you will no longer be able to renew your license. We recommend you take a look at Power Custom Fields for Jira or JMCF that are similar in functionality with an even wider set of features
We sincerely appreciate your understanding and we hope the impact to your organization and customers will be minimal. Please don't hesitate to contact our support team if you have any questions
With the XML / JSON custom fields you can retrieve end-user data from external systems and display it on a ticket. This article provides a few examples of how you can configure your HTTP feed custom fields for different versions of the plugin.
Support for parametrized GET/POST requests
This section is relevant for the app versions starting from 2.0.1.
To configure the app to support passing fields values as argument for the HTTP requests, perform the following steps:
- Add a custom field as described here.
- To configure custom field settings, click Edit XML/JSON HTTP Settings and configure the parameters as described in the configuration table. The following picture shows an example of how you can configure the fields to show a list of employees.
- To finish the configuration click Save.
As a result, a select list custom field with a list of employees in JSON format is available in your selected issue screens.
Support for different values for JSON Path and XPath
This section applies for v2.0.2 and above.
To test a JSON HTTP field, use the following resource: https://my-json-server.typicode.com/tperepelkin/requests/json.
JSON Path options:
- $.ElapsedTime - single number value (available in v2.0.2 and above)
- $.PrimaryQueryResult.QueryId - single string value (available in v2.0.2 and above)
- $..Cells[2].Value - single string value (available in v2.0.2 and above)
- $..Cells[*].Key - an array of strings
To test an XML HTTP field, use the following resource: https://www.w3schools.com/xml/books.xml.
XPath options:
- /bookstore/book[1]/author - single text value of the XML element node (available in v2.0.2 and above)
- /bookstore/book[1]/author/text() - single text value of the XML text node
- /bookstore/book[*]/author - an array of text values generated from the XML element nodes (available in v2.0.2 and above)
- /bookstore/book[*]/author/text() - an array of text values, generated from the XML text nodes
See also
HTTP - Adding XML/JSON Request Custom Field
HTTP - Adding XML/JSON Multi Request Custom Field