GET /events/helptext/<event_id>

Use the GET method to retrieve the description and recovery action for a specific event.

For message-description and user-action text in the job summary, you can specify the text directly in the request body if no translations are needed, or you can reference the text from a translated bundle file (for example, com.lenovo.lxca.server.jobs.bundle.jobsSummary).

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.
Tip: In the translated bundle files, braces {} must be escaped by a single quote for help text (for example, '{').
Attribute Required / Optional Type Description
format Required Array of strings List of formats for the text. This can be one of the following values.
  • bold. Corresponds to the <b> HTML tag.
  • italic. Corresponds to the <i> HTML tag.
  • underline. Corresponds to the <u> HTML tag.
  • link. Corresponds to the <a> HTML tag.
  • newline. Corresponds to the <br> HTML tag.
  • paragraph. Corresponds to the <p> HTML tag.
  • quotation. Corresponds to the <q> HTML tag.
  • orderedList. Corresponds to the <ol> HTML tag.
  • bulletList. Corresponds to the <ul> HTML tag.
  • listElement. Corresponds to the <li> HTML tag.

If no format is needed, use an empty array.

link Optional String URL to be linked to
text Required String or array of strings Text to be formatted
The following example has formatted text in the user action. It includes paragraphs, ordered list, unordered list, link, and formatted text. Note that braces {} must be escaped by a single quote for help text (for example, '{').
['{' 
   "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:

Illustrates current alerts that are listed in the Alerts page.

Authentication

Authentication with user name and password is required.

Request URL

GET https://<management_server_IP>/events/helptext/<event_id>

where <event_id> is the sequence number of the event to be retrieved. To obtain the event sequence number, use the cn attribute that is returned by the GET /events method).

Query parameters

None

Request body

None

Response codes

Code Description
200 OK
400 Bad request
401 Unauthorized
404 Not found
500 Internal server error

Response body

Attributes Type Description
description Array of objects Information about the message descriptions
  format Array of strings  
  text String Event description
useraction Array of objects Information about the recovery actions
  format Array of strings  
  text String Recovery actions to resolve the event

Response example

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