# GetIssue

Required Frends version: 5.5+

Required .NET version: 6.0

Compatible Agents: Crossplatform

Source code: <https://github.com/FrendsPlatform/Frends.Jira>

{% tabs %}
{% tab title="Parameter: Connection" %}

| Name                   | Description                                                                                                                              |
| ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| JiraBaseUrl : `String` | <p>Jira base URL.</p><p><br>Default: <code>-</code><br>Example: <code><https://test.jira.fi/jira></code></p>                             |
| 🗝Token : `String`     | <p>PAT or API token.</p><p><br>Default: <code>-</code><br>Example: <code>1a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6p7q8r9s0t1u2v3w4x5y6z</code></p> |
| {% endtab %}           |                                                                                                                                          |

{% tab title="Parameter: Input" %}

| Name                      | Description                                                                                                                                                                                                                               |
| ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| SearchType : `SearchType` | <p>Search type.</p><p>Possible values:</p><ul><li><code>IdOrKey</code>:</li></ul><p>Search type.</p><ul><li><code>Jql</code>:</li></ul><p>Search type.</p><p><br>Default: <code>0</code><br>Example: <code>SearchType.IssueKey</code></p> |
| IdOrKey : `String`        | <p>Specify the issue ID or key to retrieve.</p><p><br>Default: <code>-</code><br>Example: <code>TT-1, 123</code></p>                                                                                                                      |
| Jql : `String`            | <p>Use JQL to search for issues.</p><p><br>Default: <code>-</code><br>Example: <code>project=TT</code></p>                                                                                                                                |
| {% endtab %}              |                                                                                                                                                                                                                                           |

{% tab title="Parameter: Options" %}

| Name                     | Description                                                                                                                                                                       |
| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ThrowOnError : `Boolean` | <p>Throw an error on exception.</p><p>If set to false, exception message can be found in Result.ErrorMessage.</p><p><br>Default: <code>-</code><br>Example: <code>true</code></p> |
| {% endtab %}             |                                                                                                                                                                                   |

{% tab title="Result: Result" %}

| Name                    | Description                                                                                                                                                                 |
| ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Success : `Boolean`     | <p>Operation complete without errors.<br>Example: <code>true</code></p>                                                                                                     |
| Data : `JToken`         | <p>Request content as JToken.<br>Example: <code>{{"expand":"renderedFields,names,schema,operations,editmeta,changelog,versionedRepresentations","id":"151901"...</code></p> |
| ErrorMessage : `String` | <p>Error message.<br>Example: <code>An error occured...</code></p>                                                                                                          |
| {% endtab %}            |                                                                                                                                                                             |

{% tab title="Changelog" %}

## Changelog

### \[1.1.0] - 2025-03-19

#### Changed

* Update packages: Newtonsoft.Json 12.0.1 -> 13.0.3 RestSharp 110.2.0 -> 112.1.0 coverlet.collector 3.1.2 -> 6.0.4 Microsoft.NET.Test.Sdk 17.1.0 -> 17.13.0 MSTest.TestAdapter 2.2.8 -> 3.8.3 MSTest.TestFramework 2.2.8 -> 3.8.3

### \[1.0.0] - 2023-08-17

#### Added

* Initial implementation
  {% endtab %}
  {% endtabs %}