> For the complete documentation index, see [llms.txt](https://docs.wem.io/platform/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.wem.io/platform/wemreference/functions/text/formatduration.md).

# FormatDuration

{% hint style="info" %}
The **`Formatduration()`** function converts a <mark style="color:blue;">duration</mark> to <mark style="color:green;">text</mark> according to the provided format.

This function is NOT SQL compatible. For more information about SQL compatibility, see our [documentation](/platform/wemreference/sql-compatibility.md).
{% endhint %}

{% hint style="success" %}
Returns a new <mark style="color:green;">text</mark> string that is the text representation of a duration. \
Returns <mark style="color:red;">`Invalid expression`</mark> if<mark style="color:blue;">`number`</mark>is unknown or the indicated format is not valid for duration. &#x20;
{% endhint %}

### Syntax

<details>

<summary><code>FormatDuration(</code><mark style="color:blue;"><code>duration</code></mark><code>,</code><mark style="color:blue;"><code>format</code></mark><code>)</code></summary>

`FormatDuration('3d4h17m30s', "hh")`\
\=> 04

</details>

<details>

<summary><code>FormatDuration(</code><mark style="color:blue;"><code>duration</code></mark><code>,</code><mark style="color:blue;"><code>language</code></mark><code>)</code></summary>

`FormatDuration('2d3h21m54.87s', currentlanguage)`\
\=> 02:03:21:54.87

</details>

### Parameters

<table><thead><tr><th width="150">Name</th><th width="150">Type</th><th width="150" align="center">Required</th><th width="248.15953250810662">Description</th><th data-hidden>Required?</th></tr></thead><tbody><tr><td><mark style="color:blue;"><code>duration</code></mark></td><td>date time </td><td align="center"><span data-gb-custom-inline data-tag="emoji" data-code="2611">☑️</span></td><td>a duration, in minutes, hours or seconds.</td><td>yes</td></tr><tr><td><mark style="color:blue;"><code>format</code></mark></td><td>numeric</td><td align="center"><span data-gb-custom-inline data-tag="emoji" data-code="2611">☑️</span></td><td>the format is used to specify how the duration should be represented. You can find the different formats below. </td><td></td></tr><tr><td><mark style="color:blue;"><code>language</code></mark></td><td>yes/no</td><td align="center"><span data-gb-custom-inline data-tag="emoji" data-code="2611">☑️</span></td><td>this parameter is used to specify the time representation of that language. If the language parameter contains an unknown value, the default portal language is used to format the duration.</td><td></td></tr></tbody></table>

{% hint style="info" %}

The `format` parameter can contain a number of WEM specific options:

* days - returns the total number of days in the `duration`
* hours- returns the total number of hours in the `duration`
* minutes - returns the total number of minutes in the `duration`
* seconds - returns the total number of seconds in the `duration`
* long - returns the duration as a written string, based on the portal language
* stopwatch - returns the duration formatted as follows: `(hours):(minutes):(seconds)`
* clock - returns the duration formatted as follows: `(hours):(minutes)`

You can also use the \[Microsoft format strings]\(<https://msdn.microsoft.com/en-us/library/ee372287(v=vs.110).aspx> ) to format the duration.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.wem.io/platform/wemreference/functions/text/formatduration.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
