API Programming Guide › CA Enterprise Log Manager API Examples › GetObject

GetObject

You can use this command file to retrieve various types information. You can use it to retrieve a list of queries, reports, or global parameters, and the Common Event Grammar (CEG). The getObject command uses a qualifier or argument named "type" to determine what data to return to the caller as in this example:

https://ELMSERVER:5250/spin/calmapi/getObject.csp?type=type&tag=tagname1&tag=tagnamen&taglogic=OR|AND

The following list provides a summary of the types of data returned using the variations of this command:

• getQueryList

  Returns an XML string showing all the queries in CA Enterprise Log Manager. getQueryList supports many filtering parameters, which let you select and include proper query names in your API calls.

• getReportList

  Returns an XML string showing all the reports in CA Enterprise Log Manager. getReportList supports many filtering parameters, which let you select and include proper report names in your API calls.

• getDataModel

  Returns the Common Event Grammar (CEG) in XML format. You select CEG terms you want to include in API call filtering.

• getIdealModel

  Returns the ideal models defined in the CEG. You select broad product area terms you want to include in API call filtering.

• getGlobalSettings

  Returns the global settings for the CA Enterprise Log Manager server against which the command is run. You can understand what filtering is already in place for CA Enterprise Log Manager queries so you can build effective API call filters.

• getELMServers

  Returns a list of CA Enterprise Log Manager servers. This command is useful in a federated environment, because it allows you to target the parent or child servers you want to query.

• getTimeZones

  Gets a list of time zones that can be used as arguments in running queries.

• getVersion

  Returns the ELM version, which is the same as the version of the APIs, useful for diagnostic purposes.

• getObjectDefinition

  Returns the metadata for a report or query given a specific object id. Metadata is all the formatting data that governs how a report or query is presented. Use the metadata when you must use the runQuery call to acquire CA Enterprise Log Manager data for an application that cannot embed query or report viewer directly.

• getQueryViewer

  Returns the HTML containing the query viewer component preloaded with a specified query.

• getReportViewer

  Returns the HTML containing the report viewer component preloaded with a specified report.

All the GetObject commands, with the exception of getQueryViewer and getReportViewer, return an error if there is no authenticated session in the API command:

Failed Response:
<?xml version="1.0" encoding="UTF-8" ?> 
<Result>
<Value>false</Value>
	<Description> User is not logged in</Description>
</Result>

In the preceding example, the result value was "false" which indicates a failure, and the description contains the reason, in this case: "User is not logged in".