ZRM Docs
Domain Model

Deficiency Report

Fields

FieldTypeRequiredDefaultDescription
idstring.uuidYesId
createdAtstring.date-timeYesCreated at
updatedAtstring.date-timeYesUpdated at
workspaceIdstringYesID of the associated workspace
siteIdstringYesID of the associated site
workOrderIdstringNoID of the associated work order
inspectionDatestring.date-timeYesInspection date
inspectorIdstringYesID of the associated inspector
reportStatusenum(draft, submitted, reviewed, closed)YesReport status
deficiencyCountintegerYesDeficiency count
summarystringYesSummary
findingsunknownYesFindings
remediationQuoteIdstringNoID of the associated remediation quote
remediationWorkOrderIdstringNoID of the associated remediation work order
reviewedBystringNoReviewed by
reviewedAtstring.date-timeNoReviewed at
notesstringNoNotes
visibilityModeenum(global, workspace_local, shared)YesVisibility mode

Create Schema

Fields accepted when creating a new record:

FieldTypeRequiredDefaultDescription
workspaceIdstringNoID of the associated workspace
siteIdstringYesID of the associated site
workOrderIdstringNoID of the associated work order
inspectionDatestring.date-timeYesInspection date
inspectorIdstringYesID of the associated inspector
reportStatusenum(draft, submitted, reviewed, closed)Yes"draft"Report status
deficiencyCountintegerYesDeficiency count
summarystringYesSummary
findingsunknownYes[]Findings
remediationQuoteIdstringNoID of the associated remediation quote
remediationWorkOrderIdstringNoID of the associated remediation work order
reviewedBystringNoReviewed by
reviewedAtstring.date-timeNoReviewed at
notesstringNoNotes
visibilityModeenum(global, workspace_local, shared)Yes"workspace_local"Visibility mode

Update Schema

All fields are optional when updating:

FieldTypeRequiredDefaultDescription
siteIdstringNoID of the associated site
workOrderIdstringNoID of the associated work order
inspectionDatestring.date-timeNoInspection date
reportStatusenum(draft, submitted, reviewed, closed)No"draft"Report status
deficiencyCountintegerNoDeficiency count
summarystringNoSummary
findingsunknownNo[]Findings
remediationQuoteIdstringNoID of the associated remediation quote
remediationWorkOrderIdstringNoID of the associated remediation work order
reviewedBystringNoReviewed by
reviewedAtstring.date-timeNoReviewed at
notesstringNoNotes

On this page