ZRM Docs
API ReferenceMaintenance Plan

maintenancePlan.create

Type: Mutation · Auth: Workspace-aware

Input

FieldTypeRequiredDefaultDescription
customerIdstringYesID of the associated customer
siteIdstringYesID of the associated site
namestringYesName
descriptionstringNoDescription
statusenum(draft, active, suspended, expired, canceled)Yes"draft"Status
frequencyMonthsintegerYesFrequency months
startDatestring.date-timeNoStart date
endDatestring.date-timeNoEnd date
coveredSystemIdsstring[]NoCovered system ids
contractValueunknownNoContract value
ownerUserIdstringNoID of the associated owner user
workspaceIdstringNoID of the associated workspace
visibilityModeenum(global, workspace_local, shared)Yes"workspace_local"Visibility mode

Example

{
  "customerId": "550e8400-e29b-41d4-a716-446655440000",
  "siteId": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Example Name",
  "description": "A description",
  "status": "draft",
  "frequencyMonths": 0,
  "visibilityMode": "global"
}

On this page