ZRM Docs
Domain Model

Ticket

Fields

FieldTypeRequiredDefaultDescription
idstring.uuidYesId
createdAtstring.date-timeYesCreated at
updatedAtstring.date-timeYesUpdated at
customerIdstringYesID of the associated customer
siteIdstringYesID of the associated site
relatedSystemIdstringNoID of the associated related system
relatedAssetIdstringNoID of the associated related asset
ticketTypeenum(service_request, break_fix, installation, inspection, warranty, preventive, other)YesTicket type
sourceChannelenum(portal, phone, email, monitoring, internal, other)YesSource channel
priorityenum(low, medium, high, critical)YesPriority
severityenum(cosmetic, degraded, down, safety)NoSeverity
statusenum(new, triaged, assigned, in_progress, on_hold, resolved, closed)YesStatus
summarystringYesSummary
symptomDescriptionstringNoSymptom description
triageNotesstringNoTriage notes
assignedQueuestringNoAssigned queue
assignedUserIdstringNoID of the associated assigned user
reportedByContactIdstringNoID of the associated reported by contact
categorystringNoCategory
slaDueAtstring.date-timeNoSla due at
workspaceIdstringYesID of the associated workspace
visibilityModeenum(global, workspace_local, shared)YesVisibility mode
firstResponseAtunknownNoFirst response at
resolutionTimeMinutesunknownNoResolution time minutes
slaTemplateIdunknownNoID of the associated sla template
slaResponseDueAtunknownNoSla response due at
slaResolutionDueAtunknownNoSla resolution due at
slaResponseBreachedunknownNoSla response breached
slaResolutionBreachedunknownNoSla resolution breached
contactMethodunknownNoContact method
estimatedLaborHoursunknownNoEstimated labor hours
actualLaborHoursunknownNoActual labor hours
relatedTicketIdunknownNoID of the associated related ticket
closedAtunknownNoClosed at

Create Schema

Fields accepted when creating a new record:

FieldTypeRequiredDefaultDescription
customerIdstringYesID of the associated customer
siteIdstringYesID of the associated site
relatedSystemIdstringNoID of the associated related system
relatedAssetIdstringNoID of the associated related asset
ticketTypeenum(service_request, break_fix, installation, inspection, warranty, preventive, other)YesTicket type
sourceChannelenum(portal, phone, email, monitoring, internal, other)YesSource channel
priorityenum(low, medium, high, critical)Yes"medium"Priority
severityenum(cosmetic, degraded, down, safety)NoSeverity
statusenum(new, triaged, assigned, in_progress, on_hold, resolved, closed)Yes"new"Status
summarystringYesSummary
symptomDescriptionstringNoSymptom description
triageNotesstringNoTriage notes
assignedQueuestringNoAssigned queue
assignedUserIdstringNoID of the associated assigned user
reportedByContactIdstringNoID of the associated reported by contact
categorystringNoCategory
slaDueAtstring.date-timeNoSla due at
workspaceIdstringNoID of the associated workspace
visibilityModeenum(global, workspace_local, shared)Yes"workspace_local"Visibility mode
contactMethodenum(phone, email, portal, in_person, chat)NoContact method
estimatedLaborHoursnumberNoEstimated labor hours
relatedTicketIdstring.uuidNoID of the associated related ticket

Update Schema

All fields are optional when updating:

FieldTypeRequiredDefaultDescription
customerIdstringNoID of the associated customer
siteIdstringNoID of the associated site
relatedSystemIdstringNoID of the associated related system
relatedAssetIdstringNoID of the associated related asset
ticketTypeenum(service_request, break_fix, installation, inspection, warranty, preventive, other)NoTicket type
sourceChannelenum(portal, phone, email, monitoring, internal, other)NoSource channel
priorityenum(low, medium, high, critical)No"medium"Priority
severityenum(cosmetic, degraded, down, safety)NoSeverity
statusenum(new, triaged, assigned, in_progress, on_hold, resolved, closed)No"new"Status
summarystringNoSummary
symptomDescriptionstringNoSymptom description
triageNotesstringNoTriage notes
assignedQueuestringNoAssigned queue
assignedUserIdstringNoID of the associated assigned user
reportedByContactIdstringNoID of the associated reported by contact
categorystringNoCategory
slaDueAtstring.date-timeNoSla due at
contactMethodenum(phone, email, portal, in_person, chat)NoContact method
estimatedLaborHoursnumberNoEstimated labor hours
relatedTicketIdstring.uuidNoID of the associated related ticket
slaTemplateIdunknownNoID of the associated sla template
closedAtunknownNoClosed at

On this page