# Request

Required Frends version: 5.5+

Required .NET version: 6.0

Compatible Agents: Crossplatform

Source code: <https://github.com/FrendsPlatform/Frends.Confluence/tree/main/Frends.Confluence.Request>

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

| Name                                           | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| ---------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Username : `String`                            | <p>Username used to connect to confluence with Basic Auth.</p><p><br>Default: <code>-</code><br>Example: <code><john.doe@email.com></code></p>                                                                                                                                                                                                                                                                                                                                         |
| 🗝ApiToken : `String`                          | <p>ApiToken used to connect to confluence with Basic Auth.</p><p><br>Default: <code>-</code><br>Example: <code>AKxDuOPvOWAb2g1-HtJmeqnlcztevlXMqDGtsNURL88=2C9A9D12</code></p>                                                                                                                                                                                                                                                                                                         |
| HttpMethod : `HttpMethod`                      | <p>Define method of request.</p><p>Possible values:</p><ul><li><code>GET</code>:</li></ul><p>Define method of request.</p><ul><li><code>POST</code>:</li></ul><p>Define method of request.</p><ul><li><code>PUT</code>:</li></ul><p>Define method of request.</p><ul><li><code>PATCH</code>:</li></ul><p>Define method of request.</p><ul><li><code>DELETE</code>:</li></ul><p>Define method of request.</p><p><br>Default: <code>-</code><br>Example: <code>HttpMethod.Get</code></p> |
| ApiVersion : `ApiVersion`                      | <p>Api version that will be used in a request.</p><p>Possible values:</p><ul><li><code>V1</code>:</li></ul><p>Api version that will be used in a request.</p><ul><li><code>V2</code>:</li></ul><p>Api version that will be used in a request.</p><p><br>Default: <code>-</code><br>Example: <code>ApiVersion.V1</code></p>                                                                                                                                                             |
| ConfluenceDomainName : `String`                | <p>Confluence name</p><p><br>Default: <code>-</code><br>Example: <code>example-name</code></p>                                                                                                                                                                                                                                                                                                                                                                                         |
| OperationSufix : `String`                      | <p>Url suffix from of operation. All operations are described in Confluence Rest API documentation.</p><p><br>Default: <code>-</code><br>Example: <code>/audit/export</code></p>                                                                                                                                                                                                                                                                                                       |
| JsonBody : `String`                            | <p>Body content of a request if needed in a JsonF format.</p><p><br>Default: <code>-</code><br>Example: <code>-</code></p>                                                                                                                                                                                                                                                                                                                                                             |
| QueryParameters : `Dictionary<String, String>` | <p>Query parameters from which query string will be constructed.</p><p><br>Default: <code>-</code><br>Example: <code>{ {page, 1}, {limit, 5} }</code></p>                                                                                                                                                                                                                                                                                                                              |
| {% endtab %}                                   |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |

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

| Name                 | Description                                                                              |
| -------------------- | ---------------------------------------------------------------------------------------- |
| StatusCode : `Int32` | <p>Returned status code.<br>Example: <code>200</code></p>                                |
| Content : `Object`   | <p>Body of the response represented as JToken<br>Example: <code>{ "id": 123 }</code></p> |
| {% endtab %}         |                                                                                          |

{% tab title="Changelog" %}

## Changelog

### \[1.0.0] - 2024-05-21

#### Added

* Initial implementation of Frends.Confluence.Request.
  {% endtab %}
  {% endtabs %}