Get viewer definition - Documentation for BMC AMI Ops Console Management, BMC AMI Ops Console Automation, and BMC AMI Ops SecureHMC 4.1
Response body parameters
Successful completion returns a JSON object with the following parameters:
| Parameter | Data type | Description |
|---|---|---|
| description | String | The viewer description |
| sessions | Array of session objects | An array of nested object containing the included sessions. |
| mainframeRed | String | The color for red messages in HTML hexadecimal format. |
| mainframeGreen | String | The color for green messages in HTML hexadecimal format. |
| mainframeBlue | String | The color for blue messages in HTML hexadecimal format. |
| mainframeWhite | String | The color for white messages in HTML hexadecimal format. |
| mainframeYellow | String | The color for yellow messages in HTML hexadecimal format. |
| mainframeMagenta | String | The color for magenta messages in HTML hexadecimal format. |
| mainframeCyan | String | The color for cyan messages in HTML hexadecimal format. |
| bgcolor | String | The background color in HTML hexadecimal format. |
Example request
GET /mvcm-api/automation/viewers/ZOS_Consoles
x-api-session: {session id}Example response
{ "id": 18, "allSession": true, "bgcolor": "#000000", "color10": "#808000", "color11": "#000080", "color12": "#C71585", "color13": "#FFC0CB", "color14": "#FF4500", "color15": "#FFD700", "color16": "#6495ED", "color17": "#B0C4DE", "color18": "#D3D3D3", "color19": "#2F4F4F", "color9": "#008080", "dateCreated": "2023-03-30T08:22:36.231+00:00", "dateUpdated": "2023-06-19T12:25:43.469+00:00", "userCreated": "admin", "description": "", "enabled": 0, "hostId": 0, "mainframeBlue": "#87ceeb", "mainframeCyan": "#40f4f4", "mainframeGreen": "#32cd32", "mainframeMagenta": "#ffc0cb", "mainframeRed": "#ff1919", "mainframeWhite": "#ffffff", "mainframeYellow": "#ffff00", "name": "AllConsoles", "sessions": [ { "enabled": true, "name": "*Watchdog*", "startupScript": "", "serverName": "AllConsoles", "id": 216, "status": "running", "sessionType": "watchdog" }, { "enabled": true, "name": "HMCSIM", "startupScript": "", "serverName": "AllConsoles", "id": 218, "status": "running", "sessionType": "hmc" }, ], } ]
}
