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

getIncidentModel

Use the getIncidentModel command to show Common Event Grammar (CEG) fields specific to incidents in your environment. The CEG contains all the possible event fields, 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.

getIncidentModel Example

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

Returns the following XML:

<?xml version="1.0" encoding="UTF-8" ?> 
- <Result>
  <Value>true</Value> 
  <Description>Get Object Successful. Type [getIncidentModel]</Description> 
- <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" dbname="producer_msg_id" dbindex="UNIQUE NOT NULL" SnmpOID="1.3.6.1.4.1.791.9845.2.1001" /> 
  <field name="incident_createtime_gmt" type="T" class="" category="" index="y" desc="" dbtable="incidents" dbname="createtime" SnmpOID="1.3.6.1.4.1.791.9845.2.1002" /> 
  <field name="incident_name" type="S" class="" category="" index="y" desc="" dbtable="incidents" dbname="name" SnmpOID="1.3.6.1.4.1.791.9845.2.1003" /> 
  <field name="incident_rule_id" type="S" class="" category="" index="y" desc="" dbtable="incidents" dbname="rule_id" SnmpOID="1.3.6.1.4.1.791.9845.2.1004" /> 
  <field name="incident_rule_version" type="S" class="" category="" index="y" desc="" dbtable="incidents" dbname="rule_version" SnmpOID="1.3.6.1.4.1.791.9845.2.1005" /> 
  <field name="incident_rule_grouppath" type="S" class="" category="" index="y" desc="" dbtable="incidents" dbname="rule_grouppath" SnmpOID="1.3.6.1.4.1.791.9845.2.1006" /> 
		

The "field name=" element displays the incident CEG field.