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

destroy Method (msg Object)

Description

Destroy a dashboard message

Syntax

/api/v1/msg/destroy?id=id&vdc=controller-name 

Arguments

id

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

vdc

Name of the target virtual data center

Transaction Type

synchronous

Request Type

GET

Examples

Destroy a dashboard message with id 123MSG.

GET http://192.168.123.200/api/v1/msg/destroy?id=123MSG&vdc=mygrid 

Sample Output

XML:

<opt></opt>

JSON:

{} 

destroy_all Method (msg Object)

Description

Destroy all dashboard messages

Syntax

/api/v1/msg/destroy_all?vdc=controller-name 

Arguments

vdc

Name of the target virtual data center

Transaction Type

synchronous

Request Type

GET

Examples

Destroy all dashboard messages.

GET http://192.168.123.200/api/v1/msg/destroy_all?vdc=mygrid 

Sample Output

XML:

<opt></opt>

JSON:

{}

get Method (msg Object)

Description

Get text/attributes of a dashboard message

Syntax

/api/v1/msg/get?id=id&vdc=controller-name 

Arguments

id

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

vdc

Name of the target virtual data center

Transaction Type

synchronous

Request Type

GET

Examples

Get text of message with id 123MSG.

GET http://192.168.123.200/api/v1/msg/get?id=123MSG&vdc=mygrid 

Sample Output

XML:

<message> 
   <name>123MSG</name> 
   <id>123MSG</id> 
   <severity>info</severity> 
   <text>Test message</text> 
   <timestamp>1271980131</timestamp> 
</message> 

JSON:

{ 
   "message" : {
   "timestamp" : "1271980131", 
   "text" : "Test message", 
   "name" : "123MSG", 
   "id" : "123MSG", 
   "severity" : "info" 
}