ZRM Docs
API ReferenceDeficiency Report

deficiencyReport.create

Type: Mutation · Auth: Workspace-aware

Input

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

Example

{
  "workspaceId": "550e8400-e29b-41d4-a716-446655440000",
  "siteId": "550e8400-e29b-41d4-a716-446655440000",
  "workOrderId": "550e8400-e29b-41d4-a716-446655440000",
  "inspectionDate": "2024-01-15T09:00:00.000Z",
  "inspectorId": "550e8400-e29b-41d4-a716-446655440000",
  "reportStatus": "draft",
  "deficiencyCount": 0,
  "summary": "example",
  "findings": [],
  "visibilityMode": "global"
}

On this page