GET /events/activeAlerts/helptext/{alert_id}

When the job description and recovery actions require formatted text, you must specify the text as an array of objects in JSON format. You cannot use HTML.

The following example has formatted text in the user action. It includes paragraphs, ordered list, unordered list, link, and formatted text. Note that braces {} are not escaped by a single quote.

[{ 
   "text": "To display the text correctly, the following steps are made.", 
   "format": [] 
},
{
   "text": [], 
   "format": ["newline"] 
},
{
   "text": [{
      "text": "Segment the text into pieces between HTML tags.", 
      "format": ["listElement"] 
   },
   {
      "text": [{
         "text": "If the segmented text contains ", 
         "format": [] 
      },
      {
         "text": "multiple tags", 
         "format": ["bold"] 
      },
      {
         "text": ", segment them as well.", 
         "format": [] 
      }], 
      "format": ["listElement"] 
   },
   {
      "text": [ { 
         "text": "After having all segments, add the tags as follows:", 
         "format": [] 
      },
      {
         "text": [{
            "text": "Add the text between the tags in the text field of JSON. If multiple tags are found, 
                      text field is an array of JSON Objects.", 
            "format": ["listElement"] 
         },
         {
            "text": "Add the format for each text between tags.", 
            "format": ["listElement"] 
         }],
         "format": ["bulletList"] 
      }],
      "format": ["listElement"] 
   },
   {
      "text": "Make sure this is a json format.", 
      "format": ["listElement", "bold", "underline"] 
   }],
   "format": ["orderedList"]
},
{
   "text": [], 
   "format": ["newline"] 
},
{
   "text": [{ 
      "text": "This is how a paragraph looks like with a ", 
      "format": [] 
   },
   {
      "text": "link",
      "format": ["link"],
      "link": "https://www3.lenovo.com/"
   }],
   "format": ["paragraph"]
},
{
   "text": "This is how the result should look.",
   "format": ["paragraph", "italic"]
}]

This example correlates to the following HTML format

To display the text correctly, the following steps are made.
<br></br>
<ol>
<li>Segment the text into pieces between HTML tags.</li>
<li>If the segmented text contains <b>multiple tags</b>, segment them as well.</li>
<li>After having all segments, add the tags as follows:
<ul>
<li>Add the text between the tags in the text field of JSON. If multiple tags are found, 
text field is an array of JSON Objects.</li>
<li>Add the format for each text between tags.</li>
</ul></li>
<li><b><u>Make sure this is a json format.</u></b></li>
</ol>
<br></br>
<p>This is how a paragraph looks like with a <a href="https://www3.lenovo.com/">link</a></p>
<p><i>This is how the result should look.</i></p>

This example correlates to the following formatted output:

The following example is returned if the request is successful.

{
   "description": [{
      "format": [],
      "text": "The specified user cannot log in."
   }],
   "useraction": [{
      "format": [],
      "text": "Information only; no action is required."
   }]
}