Edit

Share via

Monitoring - Add Dashboard

Service:
Operations Manager
API Version:
v1

Request to save the dashboard in monitoring view.

POST http://<Servername>/OperationsManager/monitoring/dashboard

Request Body

Media Types: "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"

Name Required Type Description
name True

string

Name of Component
componentType

string

Component Type
config

string

Component Config
description

string

Description of Component
mpDescription

string

MP Description
mpId

string

Mp ID
mpName

string

MP name
mpVersion

string

MP Version
path

string

Path

Responses

Name Type Description
200 OK

ComponentResponse

OK.Successfully saved dashboard

Media Types: "application/json", "text/json", "application/xml", "text/xml"

Examples

Monitoring_AddDashboard

Sample request

POST http://<Servername>/OperationsManager/monitoring/dashboard

{
  "mpId": "dcfdedc4-68bd-42b4-1e9a-ba94b1577732",
  "mpName": "Notifications Internal Library",
  "path": "Monitoring",
  "name": "Notification Dashsboard",
  "description": "test",
  "config": null,
  "componentType": null
}

Sample response

Status code:
200 
{
  "id": "7c7cd385-30f5-312f-9123-31c2f22f6edf",
  "name": "Notification Dashsboard",
  "description": "test",
  "mpId": "dcfdedc4-68bd-42b4-1e9a-ba94b1577732",
  "componentType": null,
  "config": null
}

Definitions

Name Description
ComponentResponse
MonitoringComponentRequest

ComponentResponse

Object
Name Type Description
componentType

string

Component Type
config

string

configuration
description

string

Component Description
id

string

ID
mpId

string

Component MP ID
name

string

Component Name

MonitoringComponentRequest

Object
Name Type Description
componentType

string

Component Type
config

string

Component Config
description

string

Description of Component
mpDescription

string

MP Description
mpId

string

Mp ID
mpName

string

MP name
mpVersion

string

MP Version
name

string

Name of Component
path

string

Path