API Programming Guide › About the CA Enterprise Log Manager API › API Call Returns

API Call Returns

All API commands, with the exception of getQueryViewer and getReportViewer, return an element in the XML that describes whether the command was successful and if it was not, the reason why.

API Return Example

<?xml version="1.0" encoding="UTF-8" ?> 
<Result>
<Value>true</Value> 
<Description>Get Object Successful. Type [getQueryList]</Description> 
<Items>
<Item edit="false">
	<Panel id="Subscription/panels/Unclassified_Event_Detail" name="Unclassified Event Detail" shortname="Detail" subscription="true" type="EventViewer" version="12.0.46.5">
	<Description>Provides event details for unclassified event activity</Description> 

In this case, the result value is “true” indicating success, and the description contains the command executed.