Device - Maintenance

Get device health summary for a system

GET

http://localhost:8080

/api/device-health/system/{systemId}

Returns health scores, health statuses, and open anomaly counts for all devices in the specified system.

Get device health summary for a system › path Parameters

systemId

string · required

Get device health summary for a system › query Parameters

page

number · min: 1

Page number for pagination

Example: 1

Default: 1

size

number · min: 1 · max: 1000

Items per page

Example: 50

Default: 50

search

string

Search keyword in error message or metadata

Example: overheat

sort_by

string

Fields to sort by (comma-separated for multiple fields)

Example: createdAt,name

sort_order

string[]

Sort order for each field (comma-separated, must match sort_by length)

Enum values:

asc

desc

Example: desc,asc

healthStatus

HealthStatus · enum

Filter by health status

Enum values:

HEALTHY

WARNING

CRITICAL

OFFLINE

monitoringEnabled

boolean

Filter by monitoring enabled status

Example: true

Get device health summary for a system › Responses

Device health summary retrieved successfully

DeviceHealthSummaryDto

DeviceHealthItemDto[] · required

total

number · required

Total device count (after filtering)

Example: 25

page

number · required

Current page number

Example: 1

size

number · required

Items per page

Example: 50

Get anomalies for a system

GET

http://localhost:8080

/api/device-health/system/{systemId}/anomalies

Returns a paginated list of device anomalies for the specified system, with optional filters by type, severity, and status.

Get anomalies for a system › path Parameters

systemId

string · required

Get anomalies for a system › query Parameters

page

number · min: 1

Page number for pagination

Example: 1

Default: 1

size

number · min: 1 · max: 1000

Items per page

Example: 50

Default: 50

search

string

Search keyword in error message or metadata

Example: overheat

sort_by

string

Fields to sort by (comma-separated for multiple fields)

Example: createdAt,name

sort_order

string[]

Sort order for each field (comma-separated, must match sort_by length)

Enum values:

asc

desc

Example: desc,asc

anomalyType

AnomalyType · enum

Filter by anomaly type

Enum values:

SPIKE

DEGRADATION

DEAD_DEVICE

severity

AnomalySeverity · enum

Filter by severity

Enum values:

LOW

MEDIUM

HIGH

CRITICAL

status

AnomalyStatus · enum

Filter by status

Enum values:

OPEN

ACKNOWLEDGED

RESOLVED

FALSE_POSITIVE

deviceId

string

Filter by device ID

Get anomalies for a system › Responses

Anomalies retrieved successfully

PaginatedAnomaliesDto

DeviceAnomalyResponseDto[] · required

total

number · required

page

number · required

size

number · required

Get device health detail

GET

http://localhost:8080

/api/device-health/system/{systemId}/device/{deviceId}

Returns weekday and weekend baseline profiles plus full anomaly history for a specific device.

Get device health detail › path Parameters

systemId

string · required

deviceId

string · required

Get device health detail › Responses

Device detail retrieved successfully

DeviceDetailResponseDto

deviceId

string · required

Device ID

DeviceAnomalyResponseDto[] · required

All anomalies for this device

object

Weekday baseline

object

Weekend baseline

GET/api/device-health/system/{systemId}/device/{deviceId}

curl http://localhost:8080/api/device-health/system/:systemId/device/:deviceId

Example Responses

{
  "deviceId": "deviceId",
  "weekday": {
    "dayType": "weekday",
    "calculatedAt": "2024-08-25T15:00:00Z",
    "windowDays": 28,
    "healthScore": 85,
    "hourlyAvgUsage": 1.5,
    "hourlyStdDev": 0.3,
    "dailyAvgUsage": 12,
    "dailyStdDev": 1.2,
    "peakHourAvg": 2.1,
    "offPeakHourAvg": 0.8,
    "avgPowerFactor": 0.95,
    "avgCurrent": 2.1,
    "avgVoltage": 230,
    "avgPower": 480,
    "avgCyclesPerDay": 4,
    "avgActiveHoursPerDay": 8,
    "monitoringEnabled": true,
    "baselineResetAt": "2024-08-25T15:00:00Z",
    "mlRiskScore": 0,
    "mlIsAnomaly": true,
    "mlScoredAt": "2024-08-25T15:00:00Z"
  },
  "weekend": {
    "dayType": "weekday",
    "calculatedAt": "2024-08-25T15:00:00Z",
    "windowDays": 28,
    "healthScore": 85,
    "hourlyAvgUsage": 1.5,
    "hourlyStdDev": 0.3,
    "dailyAvgUsage": 12,
    "dailyStdDev": 1.2,
    "peakHourAvg": 2.1,
    "offPeakHourAvg": 0.8,
    "avgPowerFactor": 0.95,
    "avgCurrent": 2.1,
    "avgVoltage": 230,
    "avgPower": 480,
    "avgCyclesPerDay": 4,
    "avgActiveHoursPerDay": 8,
    "monitoringEnabled": true,
    "baselineResetAt": "2024-08-25T15:00:00Z",
    "mlRiskScore": 0,
    "mlIsAnomaly": true,
    "mlScoredAt": "2024-08-25T15:00:00Z"
  },
  "anomalies": [
    {
      "_id": "_id",
      "device": "device",
      "system": "system",
      "anomalyType": "SPIKE",
      "severity": "LOW",
      "detectedAt": "2024-08-25T15:00:00Z",
      "baselineValue": 1.5,
      "actualValue": 8.4,
      "deviationPercentage": 460,
      "explanation": "explanation",
      "status": "OPEN",
      "notes": "notes"
    }
  ]
}

json

application/json

Get all anomaly statuses

GET

http://localhost:8080

/api/device-health/anomaly/statuses

Returns all possible anomaly status values.

Get all anomaly statuses › Responses

Anomaly statuses retrieved successfully

No data returned

Distribution Box - Management

Get device health summary for a system

GET

http://localhost:8080

/api/device-health/system/{systemId}

Returns health scores, health statuses, and open anomaly counts for all devices in the specified system.

Get device health summary for a system › path Parameters

systemId

string · required

Get device health summary for a system › query Parameters

page

number · min: 1

Page number for pagination

Example: 1

Default: 1

size

number · min: 1 · max: 1000

Items per page

Example: 50

Default: 50

search

string

Search keyword in error message or metadata

Example: overheat

sort_by

string

Fields to sort by (comma-separated for multiple fields)

Example: createdAt,name

sort_order

string[]

Sort order for each field (comma-separated, must match sort_by length)

Enum values:

asc

desc

Example: desc,asc

healthStatus

HealthStatus · enum

Filter by health status

Enum values:

HEALTHY

WARNING

CRITICAL

OFFLINE

monitoringEnabled

boolean

Filter by monitoring enabled status

Example: true

Get device health summary for a system › Responses

Device health summary retrieved successfully

DeviceHealthSummaryDto

DeviceHealthItemDto[] · required

total

number · required

Total device count (after filtering)

Example: 25

page

number · required

Current page number

Example: 1

size

number · required

Items per page

Example: 50

Get anomalies for a system

GET

http://localhost:8080

/api/device-health/system/{systemId}/anomalies

Returns a paginated list of device anomalies for the specified system, with optional filters by type, severity, and status.

Get anomalies for a system › path Parameters

systemId

string · required

Get anomalies for a system › query Parameters

page

number · min: 1

Page number for pagination

Example: 1

Default: 1

size

number · min: 1 · max: 1000

Items per page

Example: 50

Default: 50

search

string

Search keyword in error message or metadata

Example: overheat

sort_by

string

Fields to sort by (comma-separated for multiple fields)

Example: createdAt,name

sort_order

string[]

Sort order for each field (comma-separated, must match sort_by length)

Enum values:

asc

desc

Example: desc,asc

anomalyType

AnomalyType · enum

Filter by anomaly type

Enum values:

SPIKE

DEGRADATION

DEAD_DEVICE

severity

AnomalySeverity · enum

Filter by severity

Enum values:

LOW

MEDIUM

HIGH

CRITICAL

status

AnomalyStatus · enum

Filter by status

Enum values:

OPEN

ACKNOWLEDGED

RESOLVED

FALSE_POSITIVE

deviceId

string

Filter by device ID

Get anomalies for a system › Responses

Anomalies retrieved successfully

PaginatedAnomaliesDto

DeviceAnomalyResponseDto[] · required

total

number · required

page

number · required

size

number · required

Get device health detail

GET

http://localhost:8080

/api/device-health/system/{systemId}/device/{deviceId}

Returns weekday and weekend baseline profiles plus full anomaly history for a specific device.

Get device health detail › path Parameters

systemId

string · required

deviceId

string · required

Get device health detail › Responses

Device detail retrieved successfully

DeviceDetailResponseDto

deviceId

string · required

Device ID

DeviceAnomalyResponseDto[] · required

All anomalies for this device

object

Weekday baseline

object

Weekend baseline