Integration Guides › Web Service API Reference Guide › Valid Web API Objects › msg Object › set Method (msg Object)

set Method (msg Object)

Description

Set text/attributes of a dashboard message

Syntax

/api/v1/msg/set?id=id&severity=severity&text="text"&vdc=controller-name 

Arguments

id

Message ID - must be in the form 'NNN<text>'

severity

Message severity, may be 'info' or 'alert'

text

Message text

vdc

Name of the target virtual data center

Transaction Type

synchronous

Request Type

GET

Examples

Create a message "test" with severity info.

GET http://192.168.123.200/api/v1/msg/set?id=123MSG&severity=info&text="Test"&vdc=mygrid 

Sample Output

XML:

<opt></opt>

JSON:

{}