> ## Documentation Index
> Fetch the complete documentation index at: https://docs.opigno.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Info messages

Info messages were designed to provide an additional information regarding the possible user
interactions with the full learning path or a separate edge.

An `infoMessage` property will be returned under `LearningPath` object in the following cases:

1. A training can be [restarted](/OpignoEnterpriseAPI/RestartTraining) due to the new available revision or an expired certificate.
2. A module attempt has been failed and can be [restarted](/OpignoEnterpriseAPI/RestartModule).
3. The user has reached the limit of attempts for the module and cannot continue the training.

`EntityInfoMessage` object contains the following properties:

| Property      | Type                | Description                                                                          |
| :------------ | :------------------ | :----------------------------------------------------------------------------------- |
| `type`        | `String`            | **Required**. Represents a category or classification of the message.                |
| `title`       | `String`            | **Required**. A headline or a primary text of the message.                           |
| `description` | `String`            | An optional string that provides an additional context or details about the message. |
| `status`      | `InfoMessageStatus` | **Required**. The message severity, available options: `WARNING`, `STATUS`, `ERROR`. |
| `cta`         | `[CTA]`             | A list of call-to-action objects that define allowed user interactions.              |

It is also possible to filter the list of the returned info messages by the type
or by the specific step edge using the following arguments for fetching `infoMessage` property:

| Argument             | Type     | Description                                                                                                                                                                                 |
| :------------------- | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `type`               | `String` | An optional filter to fetch messages based on their type.                                                                                                                                   |
| `currentStepEdgeRid` | `ID`     | An optional identifier for the current edge the user is navigating. If specified, additional step-related messages, such as a failed attempt, reached attempts limit etc, will be returned. |