# GetEssJobStatus

Required Frends version: 5.7+

Required .NET version: 8.0

Compatible Agents: Unknown

Source code: <https://github.com/FrendsPlatform/Frends.OracleFusion/tree/main/Frends.OracleFusion.GetEssJobStatus>

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

| Name                 | Description                                                                                                                  |
| -------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
| RequestId : `String` | <p>The Request ID returned by the SubmitEssJob task.</p><p><br>Default: <code>-</code><br>Example: <code>12345678</code></p> |
| {% endtab %}         |                                                                                                                              |

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

| Name                  | Description                                                                                                                                                          |
| --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| BaseUrl : `String`    | <p>Oracle Fusion instance base URL.</p><p><br>Default: <code><https://example.oraclecloud.com></code><br>Example: <code><https://example.oraclecloud.com></code></p> |
| Username : `String`   | <p>Oracle Fusion username.</p><p><br>Default: <code>-</code><br>Example: <code><john.doe@example.com></code></p>                                                     |
| 🗝Password : `String` | <p>Oracle Fusion password.</p><p><br>Default: <code>-</code><br>Example: <code>MySecretPassword123</code></p>                                                        |
| ApiVersion : `String` | <p>API version for the fscmRestApi endpoint.</p><p><br>Default: <code>latest</code><br>Example: <code>latest OR xx.xx.xx.xx</code></p>                               |
| {% endtab %}          |                                                                                                                                                                      |

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

| Name                             | Description                                                                                                                                                                                                                 |
| -------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| WaitForCompletion : `Boolean`    | <p>When true, polls until the job reaches a terminal state or timeout is reached.</p><p>When false, checks the job status once and returns immediately.</p><p><br>Default: <code>-</code><br>Example: <code>true</code></p> |
| PollingIntervalSeconds : `Int32` | <p>Polling interval in seconds to check job status.</p><p><br>Default: <code>10</code><br>Example: <code>10</code></p>                                                                                                      |
| TimeoutMinutes : `Int32`         | <p>Maximum time in minutes to wait for job completion.</p><p><br>Default: <code>60</code><br>Example: <code>60</code></p>                                                                                                   |
| IncludeLogFile : `Boolean`       | <p>Include log file in the output.</p><p><br>Default: <code>False</code><br>Example: <code>true</code></p>                                                                                                                  |
| IncludeOutputFile : `Boolean`    | <p>Include output file in the output.</p><p><br>Default: <code>False</code><br>Example: <code>true</code></p>                                                                                                               |
| ThrowErrorOnFailure : `Boolean`  | <p>Whether to throw an error on failure.</p><p><br>Default: <code>True</code><br>Example: <code>true</code></p>                                                                                                             |
| ErrorMessageOnFailure : `String` | <p>Overrides the error message on failure.</p><p><br>Default: <code>-</code><br>Example: <code>Custom error message</code></p>                                                                                              |
| {% endtab %}                     |                                                                                                                                                                                                                             |

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

| Name                                   | Description                                                                                                                                                                                                                                              |
| -------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Success : `Boolean`                    | <p>Indicates if the task completed successfully.<br>Example: <code>true</code></p>                                                                                                                                                                       |
| IsCompleted : `Boolean`                | <p>Indicates whether the job has reached a terminal state (SUCCEEDED, FAILED, WARNING, CANCELLED, ERROR). When false, the job is still running or queued. Use RequestId to check again later.<br>Example: <code>true</code></p>                          |
| RequestId : `String`                   | <p>ESS job request ID.<br>Example: <code>12345</code></p>                                                                                                                                                                                                |
| JobStatus : `String`                   | <p>Final job status (SUCCEEDED, FAILED, WARNING, CANCELLED, ERROR, etc.).<br>Example: <code>SUCCEEDED</code></p>                                                                                                                                         |
| StatusCheckedAt : `Nullable<DateTime>` | <p>The UTC timestamp of when this status check was performed.<br>Example: <code>06/30/2024 10:24:07</code></p>                                                                                                                                           |
| LogFileContent : `String`              | <p>Base64 encoded log file content (if requested and available).<br>Example: <code>UEsDBBQACAgIADdT4VAAAAAA...</code></p>                                                                                                                                |
| OutputFileContent : `String`           | <p>Base64 encoded output file content (if requested and available).<br>Example: <code>UEsDBBQACAgIADdT4VAAAAAA...</code></p>                                                                                                                             |
| OutputFiles : `List<ExtractedFile>`    | <p>List of files extracted from the ESS job output ZIP archive. Populated when IncludeLogFile or IncludeOutputFile is enabled and the job has completed.<br>Example: <code>\[{ "FileName": "report.csv", "Content": "col1,col2\nval1,val2" }]</code></p> |
| Error : `Error`                        | <p>Error that occurred during task execution.<br>Example: <code>object { string Message, Exception AdditionalInfo }</code></p>                                                                                                                           |
| {% endtab %}                           |                                                                                                                                                                                                                                                          |

{% tab title="Changelog" %}

## Changelog

### \[1.0.0] - 2026-03-10

#### Added

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