ZRM Docs
Domain Model

Incident

Fields

FieldTypeRequiredDefaultDescription
idstring.uuidYesId
createdAtstring.date-timeYesCreated at
updatedAtstring.date-timeYesUpdated at
siteIdstringYesID of the associated site
systemIdstringNoID of the associated system
incidentTypeenum(access_event, asset_failure, breach_attempt, system_error, health_check_failed, unauthorized_activity, physical_tampering, connectivity_loss, other)YesIncident type
priorityenum(low, medium, high, critical)YesPriority
statusenum(new, investigating, assigned, in_progress, resolved, closed, false_alarm)YesStatus
escalationStatusenum(not_escalated, escalated_to_team, escalated_to_manager, critical_escalation)YesEscalation status
assignedUserIdstringNoID of the associated assigned user
titlestringYesTitle
rootCauseSummarystringNoRoot cause summary
resolutionSummarystringNoResolution summary
linkedTicketIdstringNoID of the associated linked ticket
resolvedAtstring.date-timeNoResolved at
alertCountintegerYes0Alert count
workspaceIdstringYesID of the associated workspace
visibilityModeenum(global, workspace_local, shared)YesVisibility mode

Create Schema

Fields accepted when creating a new record:

FieldTypeRequiredDefaultDescription
siteIdstringYesID of the associated site
systemIdstringNoID of the associated system
incidentTypeenum(access_event, asset_failure, breach_attempt, system_error, health_check_failed, unauthorized_activity, physical_tampering, connectivity_loss, other)YesIncident type
priorityenum(low, medium, high, critical)Yes"medium"Priority
statusenum(new, investigating, assigned, in_progress, resolved, closed, false_alarm)Yes"new"Status
escalationStatusenum(not_escalated, escalated_to_team, escalated_to_manager, critical_escalation)Yes"not_escalated"Escalation status
assignedUserIdstringNoID of the associated assigned user
titlestringYesTitle
rootCauseSummarystringNoRoot cause summary
resolutionSummarystringNoResolution summary
linkedTicketIdstringNoID of the associated linked ticket
workspaceIdstringNoID of the associated workspace
visibilityModeenum(global, workspace_local, shared)Yes"workspace_local"Visibility mode

Update Schema

All fields are optional when updating:

FieldTypeRequiredDefaultDescription
siteIdstringNoID of the associated site
systemIdstringNoID of the associated system
incidentTypeenum(access_event, asset_failure, breach_attempt, system_error, health_check_failed, unauthorized_activity, physical_tampering, connectivity_loss, other)NoIncident type
priorityenum(low, medium, high, critical)No"medium"Priority
statusenum(new, investigating, assigned, in_progress, resolved, closed, false_alarm)No"new"Status
escalationStatusenum(not_escalated, escalated_to_team, escalated_to_manager, critical_escalation)No"not_escalated"Escalation status
assignedUserIdstringNoID of the associated assigned user
titlestringNoTitle
rootCauseSummarystringNoRoot cause summary
resolutionSummarystringNoResolution summary
linkedTicketIdstringNoID of the associated linked ticket

On this page