HW cloud API v1
Agent API Cloud API Cloud MCP Help OpenAPI Русский

Reference

Data models

Request and response fields in JSON. Amounts — kopecks, date-time — ISO 8601 with offset. Empty fields are omitted in responses.

AlertCommandRequestDeviceDetailDevicePatchDeviceViewErrorEventViewLatestMetricLogEntryMetricPointPointStatsReceiptRequestReceiptViewResultStatsSummary

Alert#

  • idinteger int64
  • deviceIdinteger int64
  • codestring
  • subjectstring
  • severitystring
  • messagestring
  • valuenumber double
  • openedAtstring date-time
  • updatedAtstring date-time
  • closedAtstring date-time

CommandRequest#

  • methodstring
    pattern: GET|POST|PUT|DELETE|PATCH
  • pathstringrequired
    pattern: /api/v1/.*
    from 1
  • bodyany value
  • idempotencyKeystring

DeviceDetail#

  • idinteger int64
  • namestring
  • machineIdstring
  • agentVersionstring
  • osstring
  • createdAtstring date-time
  • lastSeenAtstring date-time
  • onlineboolean
  • metricsarray of MetricPoint
  • alertsarray of Alert
  • eventsarray of EventView
  • labelstring
  • disabledboolean

DevicePatch#

  • labelstring
    from 0
    to 200
  • disabledboolean

DeviceView#

  • idinteger int64
  • machineIdstring
  • namestring
  • agentVersionstring
  • osstring
  • lastSeenAtstring date-time
  • onlineboolean
  • labelstring
  • disabledboolean
  • openAlertsinteger int32

Error#

  • codestring
  • messagestring

EventView#

  • atstring date-time
  • typestring
  • payloadobject
  • deviceIdinteger int64

LatestMetric#

  • deviceIdinteger int64
  • atstring date-time
  • namestring
  • valuenumber double
  • labelsstring

LogEntry#

  • atstring date-time
  • deviceIdinteger int64
  • methodstring
  • pathstring
  • statusinteger int32
  • errorstring
  • msinteger int32
  • sourcestring

MetricPoint#

  • atstring date-time
  • namestring
  • valuenumber double
  • labelsstring

PointStats#

  • deviceIdinteger int64
  • namestring
  • doneinteger int64
  • failedinteger int64
  • pendinginteger int64
  • totalinteger int64

ReceiptRequest#

  • idempotencyKeystring
    from 0
    to 100
  • deviceIdinteger int64
  • registerinteger int32
    from 1
    to 99
  • receiptobjectrequired
  • callbackUrlstring
    pattern: https?://.+
    from 0
    to 500

ReceiptView#

  • idinteger int64
  • idempotencyKeystring
  • statusstring
  • deviceIdinteger int64
  • registerinteger int32
  • totalinteger int64
  • attemptsinteger int32
  • createdAtstring date-time
  • doneAtstring date-time
  • resultResult
  • errorError

Result#

  • fdNumberinteger int64
  • fiscalSignstring
  • shiftNumberinteger int32
  • receiptNumberinteger int32
  • fnNumberstring
  • registrationNumberstring
  • dateTimestring
  • qrCodestring
  • fnsUrlstring
  • linkstring

Stats#

  • monthstring
  • planstring
  • paidPointsinteger int32
  • trialMonthlyinteger int32
  • trialUsedinteger int64
  • pointsinteger int64
  • doneinteger int64
  • failedinteger int64
  • totalinteger int64
  • byPointarray of PointStats

Summary#

  • devicesmap → integer int64
  • agentVersionsmap → integer int64
  • alertsmap → any value
  • requestsmap → integer int64