Invoking actions using the Common REST API


Before you begin

Invoking an action using the doAction endpoint

The doAction endpoint uses the POST method to invoke an action for a view. 

Use a URL based on the following structure. 

https://<hostName>:<portNumber>/cra/serviceGateway/services/doAction?action=<action>&product=<product>

Some content is unavailable due to permissions.

In SPE2410, we have deprecated the serviceName parameter from the URL. However, you can still use the existing URL. By default, the service name is the one you have logged in.
https://<hostName>:<portNumber>/cra/serviceGateway/services/<serviceName>/doAction?action=<action>&product=<productName>

The variables represent the following values:

  • <hostName> is the name of the mainframe host where the CRA server is running.
  • <portNumber> is the port number of the CRA server.
  • (Optional) <serviceName> is the service name you use to log in to a service. For more information, see To retrieve a list of services.

Important

By default, the service name is the one you have logged in to work with the API.


Authorization

Name

Located in

Description

Authorization

header

Authorization token formatted as 'Bearer [token]'

Query parameters

The doAction endpoint accepts the following case-sensitive parameters:

Parameter

Description

action

(Required) Action name

To get a list of available actions and their parameters, use the getAcTbl endpoint. See Retrieving-view-actions-using-the-Common-REST-API.

Example: MLCMD

lineCmd

Indicates if the action is a line command

Values: Y or N

rowNum

Row number in the view upon which to invoke the action

Obtain this value from the data endpoint in an open session or after a session has opened.

formId

Form number to use when carrying out the action

For most requests, the value is 0.

Some content is unavailable due to permissions.

formatMode

Formats the response data to JSON instead of HTML 

Values: Y or (default) N

For more details, see Getting return data using the lcdReply endpoint.

parms

Action parameters

Use parms to provide the action with specific information for the action to work successfully. Only actions that are not line commands use values specified in the parms parameter.

Specification of one or more values using parms is optional and depends on what the action requires. See the view’s action documentation for a list of actions and what, if any, parms are needed for each of them.

Header parameter

Parameter

Description

session

Session token you obtained using the data endpoint. For more information, see Retrieving-view-data-using-the-Common-REST-API.

Response data

Based on the nature of the action, we have different response data formats.

The following are some of the possible formats:

Command without interaction

Some commands return a simple status indicating that the action was performed. The current data your application may have is now stale and should be refreshed.

The following example shows using the PURGE (P) action from AutoOPERATOR to purge the output of a held job.

To invoke the action, perform a POST as follows:

https://<hostname>:<portnumber>/cra/serviceGateway/services/Mva/doAction?action=P&product=ABC&lineCmd=Y&rownum=2&formId=0&parms=%27MVSABC1X%27%20%27J0538551%27

Important

All the parameters are on a single line in the URL with no spaces. The parameter syntax includes single quotes and spaces, which have been replaced with %27 and %20 respectively. This makes the string conform to the URL standards.

This invocation purges the job named MVSABC1X with the job ID J0538551.

As with all other POST operations, the user token is sent as the body content of the request.

The following shows a successful response:

{
"session":"8098ae2c-ab69-4ed1-95df-8c8507455afb",
"version":"1.0",
"status":"0,*,DOACTION,0"
}

Command with navigate response

Some commands return a simple status along with a command to be executed.

MainView Explorer uses this command to open a new view. Your application may decide to use the command to fetch more data for a related view.

The following example shows how to navigate to the Real-time TCP CPU utilization view.

To invoke the action, perform a POST as follows:

https://<hostname>:<portnumber>/cra/serviceGateway/services/Mva/doAction?action=T&lineCmd=Y&rownum=3&formId=0

Important

All the parameters are on a single line in the URL with no spaces. The parameter syntax includes single quotes and spaces, which have been replaced with %27 and %20 respectively. This makes the string conform to the URL standards.

The rowNum parameter is an index into the view data from the JCPU view.

The following shows a successful response:

{
"session":"9bf94083-03e1-484c-b266-9853ce36adbd",
"version":"1.0",
"command":"VIEW JTCB *    81",
"status":"0,*,DOACTION,0"
}

The desired data for this action is contained in the JTCB view.

Command with dialog result

Command with dialog return information that must be filled out and returned using the lcdReply endpoint. If you are running a dialog prompt action, to complete the action, you must POST a lcdReply command. 

For more information, see the Getting return data using the lcdReply endpointsection. 


Getting return data using the lcdReply endpoint

If you are running the dialog prompt option, the dialog data is in HTML format. You can present the HTML to a user or handle it programmatically. In either case, the data for the fields described in the HTML must be returned in the lcdReply endpoint. The dialog data must be enclosed in { } while adding it to the lcdReply request body. 

The following example shows cancelling a job from the JCPU view.

To invoke the action, perform a POST as follows:

https://<hostname>:<portnumber>/cra/serviceGateway/services/Mva/doAction?action=C&lineCmd=Y&rownum=3&formId=0

All the parameters are on a single line in the URL with no spaces. The parameter syntax includes single quotes and spaces, which have been replaced with %27 and %20 respectively. This makes the string conform to the URL standards.

After processing the query, you receive the following response. 

{
  "!--": "<!--<!--\\n               Copyright (C) BMC Software, Inc. 2002\\n    Name:      BBMLYABC\\n    Description: This source module contains the\\n                 standard set of User Actions for Dialogs\\n    Change Data:\\n BPYyyyy\\n BAYaaaa\\n    Initial Revision.  24 June 2002 14:45:00   BOLLXS\\n -->\\n      <mvi-actions>\\n        <mvi-action discard=\"no\"\\n                    validate=\"yes\">\\n          <mvi-command>END</mvi-command>\\n          <mvi-label>OK</mvi-label>\\n          <mvi-title>to exit saving changes</mvi-title>\\n          <mvi-primary-command>END</mvi-primary-command>\\n          <mvi-response-action/>\\n        </mvi-action>\\n        <mvi-action discard=\"yes\"\\n                    validate=\"no\">\\n          <mvi-command>CANCEL</mvi-command>\\n          <mvi-label>Cancel</mvi-label>\\n          <mvi-title>to exit without saving changes</mvi-title>\\n          <mvi-primary-command minimum=\"3\">CANCEL</mvi-primary-command>\\n          <mvi-response-action/>\\n        </mvi-action>\\n        <mvi-action discard=\"no\"\\n                    validate=\"no\">\\n          <mvi-command>HELP</mvi-command>\\n          <mvi-label>Help</mvi-label>\\n          <mvi-title>to view related help</mvi-title>\\n          <mvi-primary-command>HELP</mvi-primary-command>\\n          <mvi-response-action/>\\n        </mvi-action>\\n        <mvi-action discard=\"no\"\\n                    validate=\"no\">\\n          <mvi-command>RESET</mvi-command>\\n          <mvi-label>Reset</mvi-label>\\n          <mvi-title>to reset to initial data</mvi-title>\\n          <mvi-primary-command minimum=\"3\">RESET</mvi-primary-command>\\n          <mvi-response-action/>\\n        </mvi-action>\\n      </mvi-actions>\\n",
  "help": "<help><help>\\n<head>\\n<title>Change Address Space Service Class\\n</title>\\n</head>\\n<body>\\n<p>You may change the address space shown to any valid service class in your current policy.\\n</p>\\n<p>In addition you may type QUIESCE to quiesce the address space or RESUME to reclassify the address space according to the current policy.\\n</p>\\n</body>\\n</help>\\n",
  "actionType": "LCD",
  "session": "975fdfde-72be-437f-a290-0af80f503bca",
  "html": "<html><html>\\n<head>\\n<title>Change Address Space Service Class\\n</title>\\n<meta\\n name=\"MVEsize\"\\n content=\"450,250\">\\n</meta>\\n<meta\\n name=\"MVEposition\"\\n content=\"0,0\">\\n</meta>\\n</head>\\n<body>\\n<table\\n cellspacing=\"10%\"\\n border=\"0\">\\n<tr\\n align=\"left\">\\n<td\\n align=\"right\"\\n nowrap=\"nowrap\">New Service Class:\\n</td>\\n<td\\n align=\"left\"\\n nowrap=\"nowrap\">\\n<input\\n type=\"text\"\\n name=\"SCLSCNM\"\\n value=\"STCGEN\"\\n error=\"\"\\n size=\"9\"\\n maxlength=\"8\"\\n align=\"left\">\\n</input>\\n</td>\\n<td\\n colspan=\"2\"\\n align=\"left\"\\n nowrap=\"nowrap\">Service Class, QUIESCE or RESUME\\n</td>\\n</tr>\\n<tr\\n align=\"left\">\\n<td\\n align=\"left\"\\n colspan=\"4\"\\n nowrap=\"nowrap\">\\n<b>�\\n</b>\\n</td>\\n</tr>\\n<tr\\n align=\"left\">\\n<td\\n align=\"right\"\\n nowrap=\"nowrap\">Jobname:\\n</td>\\n<td\\n align=\"left\"\\n nowrap=\"nowrap\">\\n<b>MIGTLPAS\\n</b>\\n</td>\\n<td>\\n</td>\\n<td>\\n</td>\\n</tr>\\n<tr\\n align=\"left\">\\n<td\\n align=\"right\"\\n nowrap=\"nowrap\">Job ID:\\n</td>\\n<td\\n align=\"left\"\\n nowrap=\"nowrap\">\\n<b>S0286117\\n</b>\\n</td>\\n<td>\\n</td>\\n<td>\\n</td>\\n</tr>\\n<tr\\n align=\"left\">\\n<td\\n align=\"right\"\\n nowrap=\"nowrap\">Step Name:\\n</td>\\n<td\\n align=\"left\"\\n nowrap=\"nowrap\">\\n<b>MIGTLPAS\\n</b>\\n</td>\\n<td\\n colspan=\"2\"\\n align=\"left\"\\n nowrap=\"nowrap\">or STC Identifier\\n</td>\\n</tr>\\n<tr\\n align=\"left\">\\n<td\\n align=\"right\"\\n nowrap=\"nowrap\">ASID (Dec):\\n</td>\\n<td\\n align=\"left\"\\n nowrap=\"nowrap\">\\n<b>336\\n</b>\\n</td>\\n<td>\\n</td>\\n<td>\\n</td>\\n</tr>\\n<tr\\n align=\"left\">\\n<td\\n align=\"right\"\\n nowrap=\"nowrap\">ASID (Hex):\\n</td>\\n<td\\n align=\"left\"\\n nowrap=\"nowrap\">\\n<b>0150\\n</b>\\n</td>\\n<td>\\n</td>\\n<td>\\n</td>\\n</tr>\\n<tr\\n align=\"left\">\\n<td\\n align=\"right\"\\n nowrap=\"nowrap\">MVS System:\\n</td>\\n<td\\n align=\"left\"\\n nowrap=\"nowrap\">\\n<b>SJSC\\n</b>\\n</td>\\n<td>\\n</td>\\n<td>\\n</td>\\n</tr>\\n</table>\\n</body>\\n</html>\\n",
  "status": "0,*,@LCD"
}

This response has the HTML section that represents the dialog, and the mvi-actions section that describes the buttons that are in this dialog.

CRA Simple dialog example.png

Important

This dialog appears only in the BMC AMI Ops User Interface and not CRA because CRA has no user interface.

Some content is unavailable due to permissions.

When the formatMode is set to Y, the dialog data is returned also in JSON format.

Consider the following sample JSON. 

Example
Click here to expand...
"dialog": {
"sections": {
"1": {
"rows": {
"1": {
"items": {
"1": {
"label": "Main"
}
}
},
"2": {
"items": {
"1": {
"label": "New Service Class:"
},
"2": {
"param": {
"SCLSCNM": "STCGEN"
}
},
"3": {
"label": "Service Class, QUIESCE or RESUME"
}
}
},
"3": {
"items": {
"1": {
"label": "Jobname:"
},
"2": {
"label": "MUXICAS"
}
}
},

}
}
},
"commands": [
"END",
"CANCEL",
"HELP",
"RESET"
]
},

This JSON represents a user interface where users interact with different parts of a dialog box by providing input.

As shown in the example, a dialog is a top-level object. It contains the following two main objects:

  • sections— this object divides the dialog into different sections
  • commands—this object contains the list of available actions or commands for the dialog

The following table describes each object in detail:

Dialog object

Description

sections

contains different sections of the dialog 

In this example, we have only one section, with the identifier 1.

1This section contains the following objects:

  • rowsThis object arranges the content into rows. Each row is identified by a number. In this section, we have three rows. 
    • 1The first row in the section. It contains the items object.
      • itemsThis object lists items within this row. Here, we have only one item.
        • 1The first item in this row. It has a label field with the value Main.
    • 2The second row in the section.
      • items—This object lists items within this row. Here, we have three items.
        • 1The first item in this row. It has a label field with the value New Service Class.
        • 2The second item with a param field with an object SCLSCNM having a value STCGEN.
        • 3The third item in this row. It has a label field with a value Service Class, QUIESCE or RESUME.
    • 3The third row in the section.
      • itemsThis object lists items within this row. Here, we have two items.
        • 1The first item in this row. It has a label field with a value Jobname.
        • 2The second item in this row. It has a label field with a value MUXICAS.

commands

Contains the list of available actions or commands for the dialog:

  • END
  • CANCEL
  • HELP
  • RESET

This section describes the following types of dialog:

Simple dialog

In the following example for changing the address space service class, see the visual representation of a simple dialog. This dialog appears only in the BMC AMI Ops User Interface and not CRA because CRA has no user interface. In CRA, the dialog is represented in the doAction response and the lcdReply action must be called after it. The parameter values and the action must be sent in the lcdReply body enclosed in { }. 

Important

Several of the JSON properties are long strings. The <html> property contains HTML suitable for prompting a user.


CRA Simple dialog example.png

To invoke the action, perform a POST as follows:

http:////<hostname>:<portnumber>/cra/serviceGateway/services/doAction?action=E&product=CMF&server=%2A&context=%2A&system=%2A&scope=%2A&rowNum=1&formId=0&lineCmd=Y&formatMode=Y

After processing the query, you receive the following response:

Click here to expand...
{
"help": "<help>\n<head>\n<title>Change Address Space Service Class\n</title>\n</head>\n<body>\n<p>You may change the address space shown to any valid service class in your current policy.\n</p>\n<p>In addition you may type QUIESCE to quiesce the address space or RESUME to reclassify the address space according to the current policy.\n</p>\n</body>\n</help>",
"dialog": {
"sections": {
"1": {
"rows": {
"1": {
"items": {
"1": {
"label": "Main"
}
}
},
"2": {
"items": {
"1": {
"label": "New Service Class:"
},
"2": {
"param": {
"SCLSCNM": "STCGEN"
}
},
"3": {
"label": "Service Class, QUIESCE or RESUME"
}
}
},
"3": {
"items": {
"1": {
"label": "Jobname:"
},
"2": {
"label": "MUXICAS"
}
}
},
"4": {
"items": {
"1": {
"label": "Job ID:"
},
"2": {
"label": "S0278303"
}
}
},
"5": {
"items": {
"1": {
"label": "Step Name:"
},
"2": {
"label": "MUXC"
},
"3": {
"label": "or STC Identifier"
}
}
},
"6": {
"items": {
"1": {
"label": "ASID (Dec):"
},
"2": {
"label": "206"
}
}
},
"7": {
"items": {
"1": {
"label": "ASID (Hex):"
},
"2": {
"label": "00CE"
}
}
},
"8": {
"items": {
"1": {
"label": "MVS System:"
},
"2": {
"label": "SJSC"
}
}
}
}
}
},
"commands": [
"END",
"CANCEL",
"HELP",
"RESET"
]
},
"actionType": "LCD",
"session": "3bd00ee6-4ec6-4f8b-8404-4f45a87d5061",
"source": {
"html": "<html>\n<head>\n<title>Change Address Space Service Class\n</title>\n<meta\n name=\"MVEsize\"\n content=\"450,250\">\n</meta>\n<meta\n name=\"MVEposition\"\n content=\"0,0\">\n</meta>\n</head>\n<body>\n<table\n cellspacing=\"10%\"\n border=\"0\">\n<tr\n align=\"left\">\n<td\n align=\"right\"\n nowrap=\"nowrap\">New Service Class:\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"SCLSCNM\"\n value=\"STCGEN\"\n error=\"\"\n size=\"9\"\n maxlength=\"8\"\n align=\"left\">\n</input>\n</td>\n<td\n colspan=\"2\"\n align=\"left\"\n nowrap=\"nowrap\">Service Class, QUIESCE or RESUME\n</td>\n</tr>\n<tr\n align=\"left\">\n<td\n align=\"left\"\n colspan=\"4\"\n nowrap=\"nowrap\">\n<b>�\n</b>\n</td>\n</tr>\n<tr\n align=\"left\">\n<td\n align=\"right\"\n nowrap=\"nowrap\">Jobname:\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<b>MUXICAS\n</b>\n</td>\n<td>\n</td>\n<td>\n</td>\n</tr>\n<tr\n align=\"left\">\n<td\n align=\"right\"\n nowrap=\"nowrap\">Job ID:\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<b>S0278303\n</b>\n</td>\n<td>\n</td>\n<td>\n</td>\n</tr>\n<tr\n align=\"left\">\n<td\n align=\"right\"\n nowrap=\"nowrap\">Step Name:\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<b>MUXC\n</b>\n</td>\n<td\n colspan=\"2\"\n align=\"left\"\n nowrap=\"nowrap\">or STC Identifier\n</td>\n</tr>\n<tr\n align=\"left\">\n<td\n align=\"right\"\n nowrap=\"nowrap\">ASID (Dec):\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<b>206\n</b>\n</td>\n<td>\n</td>\n<td>\n</td>\n</tr>\n<tr\n align=\"left\">\n<td\n align=\"right\"\n nowrap=\"nowrap\">ASID (Hex):\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<b>00CE\n</b>\n</td>\n<td>\n</td>\n<td>\n</td>\n</tr>\n<tr\n align=\"left\">\n<td\n align=\"right\"\n nowrap=\"nowrap\">MVS System:\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<b>SJSC\n</b>\n</td>\n<td>\n</td>\n<td>\n</td>\n</tr>\n</table>\n</body>\n</html>",
"actions": "<mvi-actions>\n        <mvi-action discard=\"no\"\n                    validate=\"yes\">\n          <mvi-command>END</mvi-command>\n          <mvi-label>OK</mvi-label>\n          <mvi-title>to exit saving changes</mvi-title>\n          <mvi-primary-command>END</mvi-primary-command>\n          <mvi-response-action/>\n        </mvi-action>\n        <mvi-action discard=\"yes\"\n                    validate=\"no\">\n          <mvi-command>CANCEL</mvi-command>\n          <mvi-label>Cancel</mvi-label>\n          <mvi-title>to exit without saving changes</mvi-title>\n          <mvi-primary-command minimum=\"3\">CANCEL</mvi-primary-command>\n          <mvi-response-action/>\n        </mvi-action>\n        <mvi-action discard=\"no\"\n                    validate=\"no\">\n          <mvi-command>HELP</mvi-command>\n          <mvi-label>Help</mvi-label>\n          <mvi-title>to view related help</mvi-title>\n          <mvi-primary-command>HELP</mvi-primary-command>\n          <mvi-response-action/>\n        </mvi-action>\n        <mvi-action discard=\"no\"\n                    validate=\"no\">\n          <mvi-command>RESET</mvi-command>\n          <mvi-label>Reset</mvi-label>\n          <mvi-title>to reset to initial data</mvi-title>\n          <mvi-primary-command minimum=\"3\">RESET</mvi-primary-command>\n          <mvi-response-action/>\n        </mvi-action>\n      </mvi-actions>"
},
"status": "0,*,@LCD"
}


Complex dialog

The complex dialog contains multiple fields and actions to perform. The data for the fields described in the HTML is returned in the lcdReply endpoint.

For example, see the following complex dialog.

This dialog appears only in the BMC AMI Ops User Interface and not CRA because CRA has no user interface.

Complex_dialog_example.jpg

In CRA, the following URL of lcdReply depicts the Next action on the UI. The formatMode is Y, therefore the dialog must be added to the request body enclosed in { }, but with only one value in the commands section. You can modify the param values in the dialog to other values.

https://<hostname>:<portnumber>/cra/serviceGateway/services/lcdReply?product=%2A&server=%2A&context=%2A&system=%2A&scope=%2A&formId=0&replyType=LCDREPLY&formatMode=Y

The following JSON sample contains the request body:

Click here to expand...
{
"dialog": {
"sections": {
"1": {
"rows": {
"1": {
"items": {
"1": {
"label": "Main"
}
}
},
"2": {
"items": {
"1": {
"label": "View"
},
"2": {
"label": "AMD"
},
"3": {
"label": "Unique AES"
},
"4": {
"param": {
"uniqueAES": "NO"
}
}
}
},
"3": {
"items": {
"1": {
"label": "Product"
},
"2": {
"label": "PLEXMGR"
}
}
},
"4": {
"items": {
"1": {
"label": "Context"
},
"2": {
"param": {
"context": "SJSC"
}
}
}
}
}
},
"2": {
"rows": {
"1": {
"items": {
"1": {
"label": "Parameters"
}
}
},
"2": {
"items": {
"1": {
"param": {
"parameterlinecmd": ""
}
},
"2": {
"label": "Alarm Name(MODNAME)"
},
"3": {
"label": "="
},
"4": {
"param": {
"value": "*"
}
}
}
},
"3": {
"items": {
"1": {
"param": {
"parameterlinecmd": ""
}
},
"2": {
"label": "Group Name(MODGROUP)"
},
"3": {
"label": "="
},
"4": {
"param": {
"value": "*"
}
}
}
},
"4": {
"items": {
"1": {
"param": {
"parameterlinecmd": ""
}
},
"2": {
"label": "Library Name(MODLIB)"
},
"3": {
"label": "="
},
"4": {
"param": {
"value": "*"
}
}
}
}
}
},
"3": {
"rows": {
"1": {
"items": {
"1": {
"label": "Column Filters"
}
}
},
"2": {
"items": {
"1": {
"param": {
"columnfilterlinecmd": ""
}
},
"2": {
"label": "Category(CATEGORY)"
},
"3": {
"param": {
"f-op": "="
}
},
"4": {
"param": {
"f-value": "'ALARMDEF'"
}
}
}
}
}
},
"4": {
"rows": {
"1": {
"items": {
"1": {
"label": "Where"
}
}
},
"2": {
"items": {
"1": {
"param": {
"where": ""
}
}
}
}
}
},
"5": {
"rows": {
"1": {
"items": {
"1": {
"label": "Schedule"
}
}
},
"2": {
"items": {
"1": {
"label": "Evaluate every"
},
"2": {
"param": {
"seconds": "60"
}
},
"3": {
"label": "(multiples of 5) seconds for the following"
}
}
},
"3": {
"items": {
"1": {
"label": "Every"
},
"2": {
"label": "Mon"
},
"3": {
"label": "Tue"
},
"4": {
"label": "Wed"
},
"5": {
"label": "Thur"
},
"6": {
"label": "Fri"
},
"7": {
"label": "Sat"
},
"8": {
"label": "Sun"
}
}
},
"4": {
"items": {
"1": {
"label": "Start"
},
"2": {
"param": {
"everystart": "00:00"
}
},
"3": {
"param": {
"monstart": ""
}
},
"4": {
"param": {
"tuestart": ""
}
},
"5": {
"param": {
"wedstart": ""
}
},
"6": {
"param": {
"thustart": ""
}
},
"7": {
"param": {
"fristart": ""
}
},
"8": {
"param": {
"satstart": ""
}
},
"9": {
"param": {
"sunstart": ""
}
}
}
},
"5": {
"items": {
"1": {
"label": "Stop"
},
"2": {
"param": {
"everystop": "23:59"
}
},
"3": {
"param": {
"monstop": ""
}
},
"4": {
"param": {
"tuestop": ""
}
},
"5": {
"param": {
"wedstop": ""
}
},
"6": {
"param": {
"thustop": ""
}
},
"7": {
"param": {
"fristop": ""
}
},
"8": {
"param": {
"satstop": ""
}
},
"9": {
"param": {
"sunstop": ""
}
}
}
},
"6": {
"items": {
"1": {
"label": "Start"
},
"2": {
"param": {
"everystart": ""
}
},
"3": {
"param": {
"monstart": ""
}
},
"4": {
"param": {
"tuestart": ""
}
},
"5": {
"param": {
"wedstart": ""
}
},
"6": {
"param": {
"thustart": ""
}
},
"7": {
"param": {
"fristart": ""
}
},
"8": {
"param": {
"satstart": ""
}
},
"9": {
"param": {
"sunstart": ""
}
}
}
},
"7": {
"items": {
"1": {
"label": "Stop"
},
"2": {
"param": {
"everystop": ""
}
},
"3": {
"param": {
"monstop": ""
}
},
"4": {
"param": {
"tuestop": ""
}
},
"5": {
"param": {
"wedstop": ""
}
},
"6": {
"param": {
"thustop": ""
}
},
"7": {
"param": {
"fristop": ""
}
},
"8": {
"param": {
"satstop": ""
}
},
"9": {
"param": {
"sunstop": ""
}
}
}
},
"8": {
"items": {
"1": {
"label": "Start"
},
"2": {
"param": {
"everystart": ""
}
},
"3": {
"param": {
"monstart": ""
}
},
"4": {
"param": {
"tuestart": ""
}
},
"5": {
"param": {
"wedstart": ""
}
},
"6": {
"param": {
"thustart": ""
}
},
"7": {
"param": {
"fristart": ""
}
},
"8": {
"param": {
"satstart": ""
}
},
"9": {
"param": {
"sunstart": ""
}
}
}
},
"9": {
"items": {
"1": {
"label": "Stop"
},
"2": {
"param": {
"everystop": ""
}
},
"3": {
"param": {
"monstop": ""
}
},
"4": {
"param": {
"tuestop": ""
}
},
"5": {
"param": {
"wedstop": ""
}
},
"6": {
"param": {
"thustop": ""
}
},
"7": {
"param": {
"fristop": ""
}
},
"8": {
"param": {
"satstop": ""
}
},
"9": {
"param": {
"sunstop": ""
}
}
}
},
"10": {
"items": {
"1": {
"label": "Start"
},
"2": {
"param": {
"everystart": ""
}
},
"3": {
"param": {
"monstart": ""
}
},
"4": {
"param": {
"tuestart": ""
}
},
"5": {
"param": {
"wedstart": ""
}
},
"6": {
"param": {
"thustart": ""
}
},
"7": {
"param": {
"fristart": ""
}
},
"8": {
"param": {
"satstart": ""
}
},
"9": {
"param": {
"sunstart": ""
}
}
}
},
"11": {
"items": {
"1": {
"label": "Stop"
},
"2": {
"param": {
"everystop": ""
}
},
"3": {
"param": {
"monstop": ""
}
},
"4": {
"param": {
"tuestop": ""
}
},
"5": {
"param": {
"wedstop": ""
}
},
"6": {
"param": {
"thustop": ""
}
},
"7": {
"param": {
"fristop": ""
}
},
"8": {
"param": {
"satstop": ""
}
},
"9": {
"param": {
"sunstop": ""
}
}
}
}
}
}
},
"commands": [
"NEXT"
]
}
}

The following response is when formatMode=Y. 

The following response represents the next dialog that is displayed after invoking the previous lcdReply action with the commands object value as Next.

Click here to expand...
{
 "help": "<help>\n   <head>\n      <meta name=\"3270size\" content=\"80,24\"/>\n      <meta name=\"3270position\" content=\"0,0\"/>\n      <meta name=\"MVEsize\" content=\"650,600\"/>\n      <meta name=\"MVEposition\" content=\"0,0\"/>\n      <title>Consider These Records Help</title>\n   </head>\n   <body>\n      <!-- start here -->\n      <p>\n      Use this dialog to define the subset of records that you\n      want to consider for your alarm definition.\n      </p>\n      <p>\n      Use the following fields to narrow the values and conditions\n      you are monitoring.\n      </p>\n      <p>\n      If you are creating an alarm definition\n      for a field on a customized view, some of the values and\n      conditions on this dialog are prepopulated with the\n      values from the customized view.\n      </p>\n      <h1>View</h1>\n      <p>\n      The View name identifies the MAINVIEW view used\n      for the alarm definition.  This is the view\n      used to create the alarm.  The view name cannot be changed.\n      </p>\n      <p>\n      The actual view is not used to access the data after\n      the alarm definition is created. Instead the view\n      information is incorporated into\n      the alarm definition.\n      </p>\n      <h1>Product</h1>\n      <p>\n      The Product identifies the name of the product associated\n      with the view.  The product name cannot be changed.\n      </p>\n      <h1>Context</h1>\n      <p>\n      The Context specifies the target or SSI Context for the alarm\n      definition.\n      The initial context is the one being used when MAKEALARM was issued.\n      </p>\n      <h1>Unique AES</h1>\n      <p> Set this parameter to YES to cause the alarm to be run in a\n      separate Alarm Evaluation Set.\n      </p>\n      <p> Some products, e.g.  MAINVIEW for MQSeries use parameters and\n      column filters to pre-filter data on some views.  If the filter is present\n      these views, only data that matches that filter will be\n      presented to MVI for alarm evaluation.  It is important that\n      Alarms that use these pre-filters be run in separate evaluation\n      sets.  There is currently no way for Alarm Management to determine\n      when the product is doing this pre filtering.\n      </p>\n      <p> If you suspect or are advised that you are having problems\n      because multiple alarm definitions are run in a single Alarm\n      Evaluation Set, you should set the value of this parameter to YES\n      and re-activate the alarm.  If you set Unique AES to Yes, the\n      alarm evaluator will run in a separate task and cannot be affected\n      by other alarm definitions.\n      </p>\n      <h1>Parameters</h1>\n      <p>\n      The Parameters are from the view.\n      Parameters are the\n      column filters that can be overridden when the view is invoked.\n      You may change the parameter values in the alarm definition.\n      </p>\n      <p>\n      BMC Software\n      recommends that you specify\n      the parameters you intend to use for your alarm definition\n      before issuing MAKEALARM command.\n      Specifying the parameters before using MAKEALARM\n      ensures that the records displayed in the\n      view are the records you want to consider in the alarm definition.\n      </p>\n      <h1>Column Filters</h1>\n      <p>\n      The Column Filters show you the filters from the view. You can add\n      Column filters using the Select primary command.\n      Column Filters\n      are deleted by typing a D in the space before the\n      filter and pressing enter.\n      </p>\n      <p>\n      BMC Software\n      recommends that you use view customization to specify\n      the column filters prior to issuing MAKEALARM.\n      Specifying the column filters before using MAKEALARM\n      ensures that the records displayed in the\n      view are the records you want to consider in the alarm definition.\n      </p>\n      <h1>Where</h1>\n      <p>\n      The Where clause allows you to specify complex filter\n      conditions that are applied in addition to the column filters.\n      For alarm definitions based on views that are not summarized,\n      there is no difference in the handling of Where and QWhere.\n      The where statement is the AND of any Where and QWhere.\n      </p>\n      <p>\n      BMC Software\n      recommends that you have the Where clause in effect\n      before you use MAKEALARM. Specifying the Where clause before\n      using MAKEALARM ensures that the records displayed in the\n      view are the records you want to consider in the alarm definition.\n      </p>\n      <h1>QWhere</h1>\n      <p>\n      QWhere will appear only if the alarm is based on a summary view.\n      The QWhere clause allows you to specify complex filter\n      conditions that are applied to base records to be summarized.\n      </p>\n      <p>\n      BMC Software\n      recommends that you have the QWhere clause in effect\n      before you use MAKEALARM. Specifying the QWhere clause before\n      using MAKEALARM ensures that the records displayed in the\n      view are the records you want to consider in the alarm definition.\n      </p>\n      <!--\n      <p>\n      The following examples show some common usage of\n      QWhere and Where statements.\n      </p>\n      <ul>\n      <li>\n      To filter values beginning with J or M in the\n      field with an element of ELEMENT, use the following:\n       (ELEMENT IN (j*,m*))\n      </li>\n      <li>\n      To filter values  between 5.0 and 60.5 in the\n      field with an element of ELEMENT, use the following:\n       (ELEMENT BETWEEN 5.0 AND 60.5)\n      </li>\n      <li>\n      To filter values with T in the field with an\n      element of ELEMENT and values between 2 and\n      25 in the field with an element of ELEMENT2,\n      use the following:\n       (ELEMENT = T) AND (ELEMENT2 BETWEEN 2 AND 25)\n      </li>\n      <li>\n      To filter values with an average greater\n      than 60 in the field with an element of\n      ELEMENT, use the following:\n       ELEMENT:AVG > 60\n      </li>\n      <li>\n      To filter values with a maximum greater than 80\n      in the field with an element of ELEMENT,\n      use the following:\n       ELEMENT:MAX > 80\n      </li>\n      <li>\n      To filter values with a minimum less than 20\n      in the field with an element of ELEMENT,\n      use the following:\n       ELEMENT:MIN > 20\n      </li>\n      </ul>\n      -->\n      <p>For more information on QWhere and Where statements, see the\n      MAINVIEW Alarm Management Guide.</p>\n      <h1>Schedule</h1>\n      <p>\n      The Schedule section allows you to specify two items:\n      </p>\n      <h2>Frequency</h2>\n      <p>\n      The frequency specifies, in seconds, how often the alarm conditions\n      are evaluated.\n      The frequency must be a multiple of 5 seconds and a minimum of\n      5 seconds.\n      The frequency is the single most important factor in the amount of CPU\n      used in the evaluation of alarms.\n      A lower number uses more CPU.  A higher number will use less CPU.\n      </p>\n      <h2>Periods</h2>\n      <p>\n      The periods allow you to specify start and stop times\n      for the alarm evaluation on various days of the week.\n      You can specify up to four time periods.\n      </p>\n      <p>\n      A period can specify start/stop times for every day of the week, or\n      specific days of the week but not both.\n      If the start time is later in the day than the stop time, the alarm\n      definition is\n      presumed to span midnight.  The period will start on the day specified,\n      and stop at the stop time on the following day.\n      </p>\n      <h1>Actions</h1>\n      <p>\n      The following actions are available on this dialog:\n      </p>\n      <ul>\n         <li>Next - Saves your selections and continues to the\n         next step.</li>\n         <li>CANcel - Exits the dialog without saving your changes.\n         </li>\n         <li>Select - Allows you to select more column filters.\n         </li>\n         <li>Help - Displays the dialog help.</li>\n      </ul>\n      <!-- end here -->\n   </body>\n</help>",
 "dialog": {
   "sections": {
     "1": {
       "rows": {
         "1": {
           "items": {
             "1": {
               "label": "Main"
              }
            }
          },
         "2": {
           "items": {
             "1": {
               "label": "View"
              },
             "2": {
               "label": "AMD"
              },
             "3": {
               "label": "Unique AES"
              },
             "4": {
               "param": {
                 "uniqueAES": "NO"
                }
              }
            }
          },
         "3": {
           "items": {
             "1": {
               "label": "Product"
              },
             "2": {
               "label": "PLEXMGR"
              }
            }
          },
         "4": {
           "items": {
             "1": {
               "label": "Context"
              },
             "2": {
               "param": {
                 "context": "SJSC"
                }
              }
            }
          }
        }
      },
     "2": {
       "rows": {
         "1": {
           "items": {
             "1": {
               "label": "Parameters"
              }
            }
          },
         "2": {
           "items": {
             "1": {
               "param": {
                 "parameterlinecmd": ""
                }
              },
             "2": {
               "label": "Alarm Name(MODNAME)"
              },
             "3": {
               "label": "="
              },
             "4": {
               "param": {
                 "value": "*"
                }
              }
            }
          },
         "3": {
           "items": {
             "1": {
               "param": {
                 "parameterlinecmd": ""
                }
              },
             "2": {
               "label": "Group Name(MODGROUP)"
              },
             "3": {
               "label": "="
              },
             "4": {
               "param": {
                 "value": "*"
                }
              }
            }
          },
         "4": {
           "items": {
             "1": {
               "param": {
                 "parameterlinecmd": ""
                }
              },
             "2": {
               "label": "Library Name(MODLIB)"
              },
             "3": {
               "label": "="
              },
             "4": {
               "param": {
                 "value": "*"
                }
              }
            }
          }
        }
      },
     "3": {
       "rows": {
         "1": {
           "items": {
             "1": {
               "label": "Column Filters"
              }
            }
          },
         "2": {
           "items": {
             "1": {
               "param": {
                 "columnfilterlinecmd": ""
                }
              },
             "2": {
               "label": "Category(CATEGORY)"
              },
             "3": {
               "param": {
                 "f-op": "="
                }
              },
             "4": {
               "param": {
                 "f-value": "'ALARMDEF'"
                }
              }
            }
          }
        }
      },
     "4": {
       "rows": {
         "1": {
           "items": {
             "1": {
               "label": "Where"
              }
            }
          },
         "2": {
           "items": {
             "1": {
               "param": {
                 "where": ""
                }
              }
            }
          }
        }
      },
     "5": {
       "rows": {
         "1": {
           "items": {
             "1": {
               "label": "Schedule"
              }
            }
          },
         "2": {
           "items": {
             "1": {
               "label": "Evaluate every"
              },
             "2": {
               "param": {
                 "seconds": "60"
                }
              },
             "3": {
               "label": "(multiples of 5) seconds for the following"
              }
            }
          },
         "3": {
           "items": {
             "1": {
               "label": "Every"
              },
             "2": {
               "label": "Mon"
              },
             "3": {
               "label": "Tue"
              },
             "4": {
               "label": "Wed"
              },
             "5": {
               "label": "Thur"
              },
             "6": {
               "label": "Fri"
              },
             "7": {
               "label": "Sat"
              },
             "8": {
               "label": "Sun"
              }
            }
          },
         "4": {
           "items": {
             "1": {
               "label": "Start"
              },
             "2": {
               "param": {
                 "everystart": "00:00"
                }
              },
             "3": {
               "param": {
                 "monstart": ""
                }
              },
             "4": {
               "param": {
                 "tuestart": ""
                }
              },
             "5": {
               "param": {
                 "wedstart": ""
                }
              },
             "6": {
               "param": {
                 "thustart": ""
                }
              },
             "7": {
               "param": {
                 "fristart": ""
                }
              },
             "8": {
               "param": {
                 "satstart": ""
                }
              },
             "9": {
               "param": {
                 "sunstart": ""
                }
              }
            }
          },
         "5": {
           "items": {
             "1": {
               "label": "Stop"
              },
             "2": {
               "param": {
                 "everystop": "23:59"
                }
              },
             "3": {
               "param": {
                 "monstop": ""
                }
              },
             "4": {
               "param": {
                 "tuestop": ""
                }
              },
             "5": {
               "param": {
                 "wedstop": ""
                }
              },
             "6": {
               "param": {
                 "thustop": ""
                }
              },
             "7": {
               "param": {
                 "fristop": ""
                }
              },
             "8": {
               "param": {
                 "satstop": ""
                }
              },
             "9": {
               "param": {
                 "sunstop": ""
                }
              }
            }
          },
         "6": {
           "items": {
             "1": {
               "label": "Start"
              },
             "2": {
               "param": {
                 "everystart": ""
                }
              },
             "3": {
               "param": {
                 "monstart": ""
                }
              },
             "4": {
               "param": {
                 "tuestart": ""
                }
              },
             "5": {
               "param": {
                 "wedstart": ""
                }
              },
             "6": {
               "param": {
                 "thustart": ""
                }
              },
             "7": {
               "param": {
                 "fristart": ""
                }
              },
             "8": {
               "param": {
                 "satstart": ""
                }
              },
             "9": {
               "param": {
                 "sunstart": ""
                }
              }
            }
          },
         "7": {
           "items": {
             "1": {
               "label": "Stop"
              },
             "2": {
               "param": {
                 "everystop": ""
                }
              },
             "3": {
               "param": {
                 "monstop": ""
                }
              },
             "4": {
               "param": {
                 "tuestop": ""
                }
              },
             "5": {
               "param": {
                 "wedstop": ""
                }
              },
             "6": {
               "param": {
                 "thustop": ""
                }
              },
             "7": {
               "param": {
                 "fristop": ""
                }
              },
             "8": {
               "param": {
                 "satstop": ""
                }
              },
             "9": {
               "param": {
                 "sunstop": ""
                }
              }
            }
          },
         "8": {
           "items": {
             "1": {
               "label": "Start"
              },
             "2": {
               "param": {
                 "everystart": ""
                }
              },
             "3": {
               "param": {
                 "monstart": ""
                }
              },
             "4": {
               "param": {
                 "tuestart": ""
                }
              },
             "5": {
               "param": {
                 "wedstart": ""
                }
              },
             "6": {
               "param": {
                 "thustart": ""
                }
              },
             "7": {
               "param": {
                 "fristart": ""
                }
              },
             "8": {
               "param": {
                 "satstart": ""
                }
              },
             "9": {
               "param": {
                 "sunstart": ""
                }
              }
            }
          },
         "9": {
           "items": {
             "1": {
               "label": "Stop"
              },
             "2": {
               "param": {
                 "everystop": ""
                }
              },
             "3": {
               "param": {
                 "monstop": ""
                }
              },
             "4": {
               "param": {
                 "tuestop": ""
                }
              },
             "5": {
               "param": {
                 "wedstop": ""
                }
              },
             "6": {
               "param": {
                 "thustop": ""
                }
              },
             "7": {
               "param": {
                 "fristop": ""
                }
              },
             "8": {
               "param": {
                 "satstop": ""
                }
              },
             "9": {
               "param": {
                 "sunstop": ""
                }
              }
            }
          },
         "10": {
           "items": {
             "1": {
               "label": "Start"
              },
             "2": {
               "param": {
                 "everystart": ""
                }
              },
             "3": {
               "param": {
                 "monstart": ""
                }
              },
             "4": {
               "param": {
                 "tuestart": ""
                }
              },
             "5": {
               "param": {
                 "wedstart": ""
                }
              },
             "6": {
               "param": {
                 "thustart": ""
                }
              },
             "7": {
               "param": {
                 "fristart": ""
                }
              },
             "8": {
               "param": {
                 "satstart": ""
                }
              },
             "9": {
               "param": {
                 "sunstart": ""
                }
              }
            }
          },
         "11": {
           "items": {
             "1": {
               "label": "Stop"
              },
             "2": {
               "param": {
                 "everystop": ""
                }
              },
             "3": {
               "param": {
                 "monstop": ""
                }
              },
             "4": {
               "param": {
                 "tuestop": ""
                }
              },
             "5": {
               "param": {
                 "wedstop": ""
                }
              },
             "6": {
               "param": {
                 "thustop": ""
                }
              },
             "7": {
               "param": {
                 "fristop": ""
                }
              },
             "8": {
               "param": {
                 "satstop": ""
                }
              },
             "9": {
               "param": {
                 "sunstop": ""
                }
              }
            }
          }
        }
      }
    },
   "commands": [
     "NEXT",
     "REFRESH",
     "CANCEL",
     "SELECT",
     "HELP"
    ]
  },
 "actionType": "LCD",
 "session": "6b4038b7-20ae-4800-8a18-6eca9b11f4de",
 "source": {
   "html": "<html>\n<head>\n<title>Consider These Records\n</title>\n<meta\n name=\"MVEsize\"\n content=\"800,600\">\n</meta>\n<meta\n name=\"MVEposition\"\n content=\"0,0\">\n</meta>\n</head>\n<body>\n<table\n cellspacing=\"10%\"\n border=\"0\">\n<tr\n align=\"left\">\n<td\n valign=\"bottom\"\n align=\"left\"\n nowrap=\"nowrap\">View\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<b>AMD\n</b>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">Unique AES\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"uniqueAES\"\n value=\"NO\"\n error=\"\"\n size=\"4\"\n maxlength=\"3\"\n align=\"left\">\n</input>\n</td>\n</tr>\n<tr\n align=\"left\">\n<td\n valign=\"bottom\"\n align=\"left\"\n nowrap=\"nowrap\">Product\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<b>PLEXMGR\n</b>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n</td>\n</tr>\n<tr\n align=\"left\">\n<td\n valign=\"bottom\"\n align=\"left\"\n nowrap=\"nowrap\">Context\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"context\"\n value=\"SJSC\"\n error=\"\"\n size=\"23\"\n maxlength=\"22\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n</td>\n</tr>\n</table>\n<table\n cellspacing=\"10%\"\n border=\"0\">\n<tr\n align=\"left\">\n<td\n valign=\"bottom\"\n align=\"left\"\n nowrap=\"nowrap\">\n<b>Parameters\n</b>\n</td>\n</tr>\n</table>\n<table\n cellspacing=\"10%\"\n border=\"0\">\n<tr\n align=\"left\">\n<td\n valign=\"bottom\"\n align=\"left\"\n nowrap=\"nowrap\">\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"parameterlinecmd\"\n value=\"\"\n error=\"\"\n size=\"2\"\n maxlength=\"1\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<b>Alarm Name(MODNAME)\n</b>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<b>=\n</b>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"value\"\n value=\"*\"\n error=\"\"\n size=\"48\"\n maxlength=\"47\"\n align=\"left\">\n</input>\n</td>\n</tr>\n</table>\n<table\n cellspacing=\"10%\"\n border=\"0\">\n<tr\n align=\"left\">\n<td\n valign=\"bottom\"\n align=\"left\"\n nowrap=\"nowrap\">\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"parameterlinecmd\"\n value=\"\"\n error=\"\"\n size=\"2\"\n maxlength=\"1\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<b>Group Name(MODGROUP)\n</b>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<b>=\n</b>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"value\"\n value=\"*\"\n error=\"\"\n size=\"48\"\n maxlength=\"47\"\n align=\"left\">\n</input>\n</td>\n</tr>\n</table>\n<table\n cellspacing=\"10%\"\n border=\"0\">\n<tr\n align=\"left\">\n<td\n valign=\"bottom\"\n align=\"left\"\n nowrap=\"nowrap\">\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"parameterlinecmd\"\n value=\"\"\n error=\"\"\n size=\"2\"\n maxlength=\"1\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<b>Library Name(MODLIB)\n</b>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<b>=\n</b>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"value\"\n value=\"*\"\n error=\"\"\n size=\"48\"\n maxlength=\"47\"\n align=\"left\">\n</input>\n</td>\n</tr>\n</table>\n<table\n cellspacing=\"10%\"\n border=\"0\">\n<tr\n align=\"left\">\n<td\n valign=\"bottom\"\n align=\"left\"\n nowrap=\"nowrap\">\n<b>Column Filters\n</b>\n</td>\n</tr>\n</table>\n<table\n cellspacing=\"10%\"\n border=\"0\">\n<tr\n align=\"left\">\n<td\n valign=\"bottom\"\n align=\"left\"\n nowrap=\"nowrap\">\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"columnfilterlinecmd\"\n value=\"\"\n error=\"\"\n size=\"2\"\n maxlength=\"1\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<b>Category(CATEGORY)\n</b>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"f-op\"\n value=\"=\"\n error=\"\"\n size=\"4\"\n maxlength=\"3\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"f-value\"\n value=\"'ALARMDEF'\"\n error=\"\"\n size=\"50\"\n maxlength=\"49\"\n align=\"left\">\n</input>\n</td>\n</tr>\n</table>\n<table\n cellspacing=\"10%\"\n border=\"0\">\n<tr\n align=\"left\">\n<td\n valign=\"bottom\"\n align=\"left\"\n nowrap=\"nowrap\">\n<b>Where\n</b>\n</td>\n</tr>\n</table>\n<form>\n<textarea\n name=\"where\"\n rows=\"7\"\n cols=\"74\"\n wrap=\"hard\">\n</textarea>\n</form>\n<table\n cellspacing=\"10%\"\n border=\"0\">\n<tr\n align=\"left\">\n<td\n valign=\"bottom\"\n align=\"left\"\n nowrap=\"nowrap\">\n<b>Schedule\n</b>\n</td>\n</tr>\n</table>\n<table\n cellspacing=\"10%\"\n border=\"0\">\n<tr\n align=\"left\">\n<td\n valign=\"bottom\"\n align=\"left\"\n nowrap=\"nowrap\">\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">Evaluate every\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"seconds\"\n value=\"60\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">(multiples of 5) seconds for the following\n</td>\n</tr>\n</table>\n<table\n cellspacing=\"10%\"\n border=\"0\">\n<tr\n align=\"left\">\n<td\n valign=\"bottom\"\n align=\"left\"\n nowrap=\"nowrap\">\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">Every\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">Mon\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">Tue\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">Wed\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">Thur\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">Fri\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">Sat\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">Sun\n</td>\n</tr>\n<tr\n align=\"left\">\n<td\n valign=\"bottom\"\n align=\"left\"\n nowrap=\"nowrap\">\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">Start\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"everystart\"\n value=\"00:00\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"monstart\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"tuestart\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"wedstart\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"thustart\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"fristart\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"satstart\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"sunstart\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n</tr>\n<tr\n align=\"left\">\n<td\n valign=\"bottom\"\n align=\"left\"\n nowrap=\"nowrap\">\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">�Stop\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"everystop\"\n value=\"23:59\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"monstop\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"tuestop\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"wedstop\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"thustop\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"fristop\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"satstop\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"sunstop\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n</tr>\n<tr\n align=\"left\">\n<td\n valign=\"bottom\"\n align=\"left\"\n nowrap=\"nowrap\">\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">Start\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"everystart\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"monstart\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"tuestart\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"wedstart\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"thustart\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"fristart\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"satstart\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"sunstart\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n</tr>\n<tr\n align=\"left\">\n<td\n valign=\"bottom\"\n align=\"left\"\n nowrap=\"nowrap\">\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">�Stop\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"everystop\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"monstop\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"tuestop\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"wedstop\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"thustop\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"fristop\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"satstop\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"sunstop\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n</tr>\n<tr\n align=\"left\">\n<td\n valign=\"bottom\"\n align=\"left\"\n nowrap=\"nowrap\">\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">Start\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"everystart\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"monstart\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"tuestart\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"wedstart\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"thustart\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"fristart\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"satstart\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"sunstart\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n</tr>\n<tr\n align=\"left\">\n<td\n valign=\"bottom\"\n align=\"left\"\n nowrap=\"nowrap\">\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">�Stop\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"everystop\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"monstop\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"tuestop\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"wedstop\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"thustop\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"fristop\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"satstop\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"sunstop\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n</tr>\n<tr\n align=\"left\">\n<td\n valign=\"bottom\"\n align=\"left\"\n nowrap=\"nowrap\">\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">Start\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"everystart\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"monstart\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"tuestart\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"wedstart\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"thustart\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"fristart\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"satstart\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"sunstart\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n</tr>\n<tr\n align=\"left\">\n<td\n valign=\"bottom\"\n align=\"left\"\n nowrap=\"nowrap\">\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">�Stop\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"everystop\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"monstop\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"tuestop\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"wedstop\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"thustop\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"fristop\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"satstop\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n<td\n align=\"left\"\n nowrap=\"nowrap\">\n<input\n type=\"text\"\n name=\"sunstop\"\n value=\"\"\n error=\"\"\n size=\"6\"\n maxlength=\"5\"\n align=\"left\">\n</input>\n</td>\n</tr>\n</table>\n</body>\n</html>",
   "actions": "<mvi-actions>\n<mvi-action\n discard=\"no\"\n validate=\"yes\">\n<mvi-command>NEXT\n</mvi-command>\n<mvi-label>Next\n</mvi-label>\n<mvi-title>to goto next step\n</mvi-title>\n<mvi-primary-command\n minimum=\"1\">Next\n</mvi-primary-command>\n<mvi-response-action>\n</mvi-response-action>\n</mvi-action>\n<mvi-action\n discard=\"no\"\n validate=\"yes\"\n visible=\"MVE\">\n<mvi-command>REFRESH\n</mvi-command>\n<mvi-label>Refresh\n</mvi-label>\n<mvi-title>to refresh\n</mvi-title>\n<mvi-primary-command\n minimum=\"1\">ENTER\n</mvi-primary-command>\n<mvi-response-action>\n</mvi-response-action>\n</mvi-action>\n<mvi-action\n discard=\"no\"\n validate=\"no\">\n<mvi-command>CANCEL\n</mvi-command>\n<mvi-label>Cancel\n</mvi-label>\n<mvi-title>to exit without saving changes\n</mvi-title>\n<mvi-primary-command\n minimum=\"3\">CANcel\n</mvi-primary-command>\n<mvi-response-action>\n</mvi-response-action>\n</mvi-action>\n<mvi-action\n discard=\"no\"\n validate=\"yes\">\n<mvi-command>SELECT\n</mvi-command>\n<mvi-label>Select\n</mvi-label>\n<mvi-title>to select elements for filters\n</mvi-title>\n<mvi-primary-command\n minimum=\"1\">Select\n</mvi-primary-command>\n<mvi-response-action>\n</mvi-response-action>\n</mvi-action>\n<mvi-action\n discard=\"no\"\n validate=\"no\">\n<mvi-command>HELP\n</mvi-command>\n<mvi-label>Help\n</mvi-label>\n<mvi-title>to goto help\n</mvi-title>\n<mvi-primary-command>HELP\n</mvi-primary-command>\n<mvi-response-action>\n</mvi-response-action>\n</mvi-action>\n</mvi-actions>"
  },
 "status": "0,*,@LCD"
}


HTTP status and reason codes

The following HTTP status codes are returned for the indicated errors, and the response body is a standard error response body providing the reason code indicated and the associated error message.


Error Code

Explanation

200

Successful completion

403

Unauthorized. The authorization token is missing, invalid, or expired

404

The path is not valid. The message indicates what the issue is.

Message

Explanation

Invalid product name

You entered an empty product name.

Invalid view

You entered an empty BMC AMI Ops view name.

Invalid context

You entered an empty context name.

Invalid server

You entered an empty server name.

Invalid system

You entered an empty system name.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*