UKG · Schema

Shift

Scheduled work shift

Human Capital ManagementHCMWorkforce ManagementHRPayrollTime and AttendanceBenefitsScheduling

Properties

Name Type Description
shiftId string Shift identifier
employeeId string Employee identifier
locationId string Work location
shiftDate string Date of the shift
startTime string Shift start time (HH:MM)
endTime string Shift end time (HH:MM)
totalHours number Total scheduled hours
jobCode string Job code for the shift
status string Shift status
View JSON Schema on GitHub

JSON Schema

pro-wfm-shift-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ukg/refs/heads/main/json-schema/pro-wfm-shift-schema.json",
  "title": "Shift",
  "description": "Scheduled work shift",
  "type": "object",
  "properties": {
    "shiftId": {
      "type": "string",
      "description": "Shift identifier",
      "example": "EMP001"
    },
    "employeeId": {
      "type": "string",
      "description": "Employee identifier",
      "example": "EMP001"
    },
    "locationId": {
      "type": "string",
      "description": "Work location",
      "example": "LOC-NYC"
    },
    "shiftDate": {
      "type": "string",
      "format": "date",
      "description": "Date of the shift",
      "example": "2026-01-15"
    },
    "startTime": {
      "type": "string",
      "description": "Shift start time (HH:MM)",
      "example": "09:00"
    },
    "endTime": {
      "type": "string",
      "description": "Shift end time (HH:MM)",
      "example": "17:00"
    },
    "totalHours": {
      "type": "number",
      "format": "double",
      "description": "Total scheduled hours",
      "example": 8.0
    },
    "jobCode": {
      "type": "string",
      "description": "Job code for the shift",
      "example": "example-value"
    },
    "status": {
      "type": "string",
      "description": "Shift status",
      "example": "Scheduled",
      "enum": [
        "Scheduled",
        "Open",
        "Filled",
        "Cancelled"
      ]
    }
  }
}