UpKeep · Schema

UpKeep Work Order

A maintenance work order in the UpKeep CMMS platform

CMMSMaintenance ManagementAsset ManagementFacility ManagementWork Orders

Properties

Name Type Description
id string Unique work order identifier
title string Work order title
description string
status string
priority string
assetId string Associated asset identifier
locationId string Location identifier
assignedToId string Assigned technician/user ID
dueDate string
estimatedHours number
actualHours number
category string
createdAt string
updatedAt string
completedAt string
View JSON Schema on GitHub

JSON Schema

upkeep-work-order-schema.json Raw ↑ 
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/upkeep/main/json-schema/upkeep-work-order-schema.json",
  "title": "UpKeep Work Order",
  "description": "A maintenance work order in the UpKeep CMMS platform",
  "type": "object",
  "required": ["id", "title", "status"],
  "properties": {
    "id": { "type": "string", "description": "Unique work order identifier" },
    "title": { "type": "string", "description": "Work order title" },
    "description": { "type": "string" },
    "status": { "type": "string", "enum": ["open", "in-progress", "on-hold", "complete"] },
    "priority": { "type": "string", "enum": ["none", "low", "medium", "high"] },
    "assetId": { "type": "string", "description": "Associated asset identifier" },
    "locationId": { "type": "string", "description": "Location identifier" },
    "assignedToId": { "type": "string", "description": "Assigned technician/user ID" },
    "dueDate": { "type": "string", "format": "date" },
    "estimatedHours": { "type": "number" },
    "actualHours": { "type": "number" },
    "category": { "type": "string" },
    "createdAt": { "type": "string", "format": "date-time" },
    "updatedAt": { "type": "string", "format": "date-time" },
    "completedAt": { "type": "string", "format": "date-time" }
  }
}