Skip to main content
Version: 2.2.0

The Incident Object

Within the Incident Management service, an Incident serves as the fundamental unit of data. It is an object-oriented construct designed to encapsulate and store concise information pertaining to a specific occurrence.

Attributes

AttributeDescriptionType
idUnique identifier for the incident (e.g., UUID).String (UUID)
nameA concise and descriptive name for the incident.String
statusCurrent status of the incident (e.g., "New," "In Progress," "Resolved," "Closed"). The allowed values in this field are backed by a code table called incident_typeString (Enum)
typeCategory or type of the incident (e.g., "Security," "Performance," "Maintenance"). The allowed values in this field are backed by a code table called incident_statusString
dateDate and time when the incident occurred.Date/Time
descriptionDetailed description of the incident, including symptoms, observed behavior, and any relevant information.String
reported_byName or ID of the individual who initially reported the incident.String
attributesA key-value pair object for storing custom attributes specific to the incident.Object
locationLocation where the incident occurred (if applicable).String
severitySeverity level of the incident (e.g., "Low," "Medium," "High," "Critical").String (Enum)
next_updateTimestamp of the next expected update on the incident.Date/Time
resolved_dateDate and time when the incident was resolved.Date/Time
backdatedBoolean flag indicating whether the incident was reported after it actually occurred.Boolean
created_atTimestamp of when the incident record was created in the system.Date/Time
created_byUser who created the incident record.String
updated_atTimestamp of the last update to the incident record.Date/Time
updated_byUser who last updated the incident record.String
tenant_idIdentifier for the organization or tenant to which this incident belongs (for multi-tenant systems).String
occ_lockOptimistic locking field used for concurrent updates to prevent data inconsistencies.Integer