With the XML / JSON Multi Request custom field you can retrieve end-user data from external systems and display it on a support ticket.
Support for parametrized GET/POST requests
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 table below. 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
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
Fields description
For each XML or 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) |
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) | 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 Request Custom Field