ManageEngine® SQLDBManager Plus


List Actions

<< Prev

Home

Next >>

ListActions API

 

This API lists all the actions configured for the monitors associated to the users. The details of each action is grouped according to the action type.

 

API for XML Response:

http://[ SQLDBM Host ]:[ SQLDBM Port ]/AppManager/xml/ListActions?apikey=[ API Key ]&type=all

 

API for JSON Response:

http://[ SQLDBM Host ]:[ SQLDBM Port ]/AppManager/json/ListActions?apikey=[ API Key ]&type='all'

 

In future versions the following features will be included:

i) Listing Actions will be supported in Admin server.

ii) Listing Actions based on the type.

 

Request Parameters:

 

Field Description
type This value specifies the type of action to be listed, to get all types of actions, we need to pass 'all' as the value for the field type.(In absence of this parameter also it will return all the types)

 

Response Details:

Field Description
DisplayName This is the displayname of the action.
Action

ID - Represents the Action ID
ExecuteActionPath - Represents the uri for executing the action
NAME - Represents the Name of the Action
ActionProps - Represents the Action Proepeties like From Address, To Address, Message etc., this changes for each and every action type
<AppManager-response uri="/AppManager/xml/ListActions">
<result>
<response response-code="4000">
<Actions DisplayName="SMS Action(s)">
<Action ID="10000003" ExecuteActionPath="/common/executeSMS.do?method=testAction&remote=true&actionID=10000003" NAME="SMS">
<ActionProps MESSAGE="This information has been generated by the SQLDBManagerPlus" FROMADDRESS="karthi@zohomail.com" TOADDRESS="karthi@zohomail.com" />
</Action>
</Actions>
</response>
</result>
</AppManager-response>

JSON Input

http://sqldbm-prod1:9433/AppManager/json/ListActions?apikey=c4e547c2330e2eb92d3e7af2262da9e9&type='all'

JSON Response

{"response-code":"4000","response":{"uri":"/AppManager/json/ListActions","result":[{"Action":[{"ID":"20000003","ExecuteActionPath":"/common/executeAction.do?method=testAction&remote=true&actionID=20000003","NAME":"alert_mail","ActionProps":{"FROMADDRESS":"user1@zohocorp.com","TOADDRESS":"user2@zohocorp.com","SUBJECT":"Alarm from the SQLDBManagerPlus"}}],"DisplayName":"E-mail Action(s)"}]}}

 

 

 

<< Prev

Home

Next >>

Get Monitor Data

List Alarms