incidententity.md

IncidentEntity

IncidentEntity model

Fields

Field	Type	Required	Description
ID	*string	➖	UUID of the Incident
Name	*string	➖	Name of the incident
CreatedAt	*time.Time	➖	The time the incident was opened
StartedAt	*time.Time	➖	The time the incident started
DiscardedAt	*time.Time	➖	The time the incident was archived
Summary	*string	➖	N/A
CustomerImpactSummary	*string	➖	N/A
Description	*string	➖	N/A
CurrentMilestone	*string	➖	The type/slug of the current milestone. Will be one of the currently configured milestones for the given incident.
Number	*int	➖	Incident number
Priority	*string	➖	N/A
Severity	*string	➖	N/A
SeverityColor	*string	➖	N/A
SeverityImpact	*string	➖	N/A
SeverityCondition	*string	➖	N/A
TagList	[]string	➖	N/A
SeverityImpactObject	*components.SeverityMatrixImpactEntity	➖	SeverityMatrix_ImpactEntity model
SeverityConditionObject	*components.SeverityMatrixConditionEntity	➖	SeverityMatrix_ConditionEntity model
PrivateID	*string	➖	N/A
OrganizationID	*string	➖	N/A
Milestones	[]components.IncidentsMilestoneEntity	➖	DEPRECATED: Please use lifecycle phases instead
LifecyclePhases	[]components.IncidentsLifecyclePhaseEntity	➖	N/A
LifecycleMeasurements	[]components.IncidentsLifecycleMeasurementEntity	➖	N/A
Active	*bool	➖	N/A
Labels	*components.IncidentEntityLabels	➖	A key/value of labels
RoleAssignments	[]components.IncidentsRoleAssignmentEntity	➖	N/A
StatusPages	[]components.IncidentsStatusPageEntity	➖	N/A
IncidentURL	*string	➖	N/A
PrivateStatusPageURL	*string	➖	N/A
Organization	*components.OrganizationEntity	➖	N/A
CustomersImpacted	*int	➖	N/A
MonetaryImpact	*int	➖	N/A
MonetaryImpactCents	*int	➖	N/A
LastUpdate	*string	➖	N/A
LastNote	*components.EventNoteEntity	➖	Event_NoteEntity model
ReportID	*string	➖	N/A
AiIncidentSummary	*string	➖	N/A
Services	[]components.SuccinctEntity	➖	N/A
Environments	[]components.SuccinctEntity	➖	N/A
Functionalities	[]components.SuccinctEntity	➖	N/A
ChannelName	*string	➖	N/A
ChannelReference	*string	➖	N/A
ChannelID	*string	➖	N/A
ChannelStatus	*string	➖	inoperative: 0, operational: 1, archived: 2
IncidentTickets	[]components.TicketingTicketEntity	➖	N/A
Ticket	*components.TicketingTicketEntity	➖	Ticketing_TicketEntity model
Impacts	[]components.IncidentsImpactEntity	➖	N/A
ConferenceBridges	[]components.IncidentsConferenceBridgeEntity	➖	N/A
IncidentChannels	[]components.IncidentsChannelEntity	➖	N/A
RetroExports	[]components.RetroExports	➖	A list of objects attached to this item. Can be one of: LinkEntity, CustomerSupportIssueEntity, or GenericAttachmentEntity
CreatedBy	*components.AuthorEntity	➖	N/A
ContextObject	*components.IncidentsContextObjectEntity	➖	N/A
TeamAssignments	[]components.IncidentsTeamAssignmentEntityLite	➖	N/A
Conversations	[]components.ConversationsAPIEntitiesReference	➖	N/A
CustomFields	[]components.CustomFieldsFieldValue	➖	N/A
FieldRequirements	[]components.IncidentEntityFieldRequirementEntity	➖	N/A