API Programming Guide › CA User Activity Reporting Module API Examples › GetObject › getObjectDefinition

getObjectDefinition

Use the getObjectDefinition command to show the formatting and layout data specific to a query or report in XML format. You can view formatting data in existing reports to create custom formatting, especially using the runQuery command. You can use getObjectDefinition to return data on both subscription and custom user-defined reports or queries.

getObjectDefinition Example

https://ELMSERVER:5250/spin/calmapi/getObject.csp?type=getObjectDefinition&objectId=Subscription/panels/Unclassified_Event_Trend

Returns the following XML:

?xml version="1.0" encoding="UTF-8" ?> 
<Result>
	<Value>true</Value> 
	<Description>Get Object Successful. Type [getObjectDefinition]</Description> 
	<Panel id="Subscription/panels/Unclassified_Event_Trend" name="Unclassified Event Trend" shortname="Trend" subscription="true" version="12.0.46.5">
		<Description>Provides Trending for unclassified event activity</Description> 
		<Tags>
			<Tag name="Unclassified Event" /> 
  			<Tag name="Unknown Category" /> 
		</Tags>
  		<Params /> 
		<Query>

This example shows the formatting data for the Unclassified Event Trend query. The “objectId” parameter in the call specifies which query or report formatting to display. In this case, it is the Unclassified Event Trend query in the Subscription queries folder.

More information:

runQuery