Previous Topic: getDataModelNext Topic: getIncidentModel


getCombinedModel

Use the getCombinedModel command to show formatting data specific to the Common Event Grammar (CEG) for both events and incidents. The CEG contains all the possible event fields contained in the schema, a description of each field and possible values for each field (if applicable). You can correctly identity CEG fields for any filtering you want to include in a call.

getCombinedModel Example

https://ELMSERVER:5250/spin/calmapi/getObject.csp?type=getCombinedModel 

Returns the following XML:

			<?xml version="1.0" encoding="UTF-8" ?> 
- <Result>
  <Value>true</Value> 
  <Description>Get Object Successful. Type [getCombinedModel]</Description> 
- <CEGFields>
+ <events>
- <incidents>
- <CommonEventGrammar version="12.1.5109.0">
  <SchemaVersion value="1" desc="Incident Schema version, integer, incremented starting at 1 (no version=0)" /> 
  <field internal="true" name="" type="" class="" category="" index="" desc="" dbtable="version" dbname="value" dbtype="INTEGER" dbindex="NOT NULL" /> 
  <field internal="true" name="" type="" class="" category="" index="" desc="" dbtable="version" dbname="timestamp" dbtype="INTEGER" dbindex="NOT NULL" /> 
  <field name="incident_id" type="S" class="" category="" index="y" desc="" dbtable="incidents" 

The "field name=" element displays the CEG field, in this case incident_id.

The "dbtable=" element identified the database type, in this case the incident database.