Get Issue
Description
Jira Get Issue Plugin step gets an issue from an instance of JIRA software.
Configurations
| No. | Field Name | Description |
|---|---|---|
| 1 | Step Name | Name of the step. This name has to be unique in a single workflow. |
| Connection | ||
| 2 | Base URL | For on-premise JIRA instance specify IP/Fully Qualified Domain Name/Hostname:Port of the JIRA Server (e.g. xxx.xxx.xxx.xxx:Port). Port can be optional as per network configuration. In case of Cloud instance specify the JIRA instance URL (e.g. https://xxxx.atlassian.net/). |
| 3 | Username | A username with appropriate permissions to authenticate to JIRA instance and get issue. This field is mandatory. |
| Password/AP Key | ||
| 4 | Accept Value as variable/static | Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. Else enable checkbox for Password field to appear as Text box. |
| 5 | Password/API Key | Provide Password of the username to authenticate in case of on premise instance and API Key in case of on cloud instance Password/API is entered using a widget. The widget handles both Text (static value or environment variable) and Combo (drop down containing values from previous steps). This field is mandatory. If checkbox above is enabled Password/API field appears as Text box and accepts static or variable values. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps. Note: Following is the link to find the steps to generate token for on-cloud JIRA instance: https://confluence.atlassian.com/cloud/api-tokens-938839638.html |
| 6 | Test Connection | Verifies whether the connection is established or not. Note: For the purpose of verification fields coming from previous steps are not allowed since field values can only be accessed when workflow is in running state. Static values and environment variables are allowed. |
| Input Fields | ||
| 1 | Issue Key | Specify the issue key of an issue to get. The issue key can be chosen from a pop-up obtained by clicking the Get button next to it as described below. Note: REST API can get maximum of 1000 and 100 issues for on-premise and on-cloud instances respectively. This is an intentional limitation on JIRA applications to avoid performance-related issues such as an OutOfMemoryException. |
| 2 | Get | Clicking on this button brings up the issue keys available as per the access permission of Username provided in the Connection. Note: The latest 50 issues are displayed which is the default outcome of the REST call. |
| Output Fields: | Either JSON Output or Table Fields should be selected in the Output tab. | |
| 1 | JSON Output | Enable checkbox to Get Issue fields as JSON text. |
| 2 | JSON Output Field | If ‘JSON Out’ checkbox is enabled, this field is activated. Provide a field to capture the JSON text. JSON text contains key-value pairs enclosed by double quotes (“) enclosure with a colon separating them. Key value pairs deNote: field Ids and their values. Sample output JSON for field Id status in Issues is shown below. “status”:{"self": "http://localhost:8003/rest/api/2/status/10000","description":"",“iconUrl”: http://localhost:8003/images/icons/status_generic.gif,“name”: “To Do”,“id”: “10000”;<br/>“statusCategory”: {“self”: "http://localhost:8003/rest/api/2/statuscategory/2","id": 2,"key": "new","colorName": "blue-gray","name": "To Do"}}Note - At least one output field must be provided. Either using JSON or Table Fields. - The Field names and their respective Ids can be found using below REST call GET {Instance URL }/rest/api/2/field |
| Table Fields | ||
| 3 | Field Name | On the click of this cell, field explorer appears with Issue Field Names (Display names). elect the fields whose values are to be fetched. |
| 4 | Output Field | Specify an output field to hold the field values. |