response_command_record

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/blumira/main/json-schema/blumira-response-command-record-schema.json",
  "title": "response_command_record",
  "x-generated": "2026-09-29",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/blumira-openapi.yml#/components/schemas/response_command_record",
  "properties": {
    "action": {
      "description": "Response action that was dispatched",
      "type": "string"
    },
    "command_id": {
      "description": "UUID of the command",
      "format": "uuid",
      "type": "string"
    },
    "device_id": {
      "description": "UUID of the agent device the command targets",
      "format": "uuid",
      "type": "string"
    },
    "dispatched_at": {
      "description": "When the command was dispatched",
      "format": "date-time",
      "type": "string"
    },
    "error": {
      "$ref": "#/$defs/error_envelope",
      "nullable": true
    },
    "result": {
      "description": "Action-specific terminal result; null until the command reaches a terminal status. Task actions: {exit_code, reason?}. isolate/deisolate: {is_isolated}. Fan-out (parent commands): {children: [{device_id, status, exit_code?, error?}]}.",
      "type": [
        "object",
        "null"
      ]
    },
    "status": {
      "description": "Current lifecycle status of the command",
      "enum": [
        "accepted",
        "running",
        "succeeded",
        "failed",
        "timed_out",
        "dispatch_failed"
      ],
      "type": "string"
    },
    "terminal_at": {
      "description": "When the command reached a terminal status; null until then",
      "format": "date-time",
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "command_id",
    "action",
    "device_id",
    "status",
    "dispatched_at"
  ],
  "type": "object",
  "$defs": {
    "error_envelope": {
      "properties": {
        "code": {
          "description": "Machine-readable error code discriminating the failure reason",
          "enum": [
            "invalid_param",
            "guardrail_reject",
            "sensor_not_in_org",
            "unknown_sensor",
            "dispatch_disabled",
            "rate_capped",
            "device_locked",
            "unsupported_os",
            "idempotency_conflict",
            "dispatch_failed"
          ],
          "type": "string"
        },
        "details": {
          "description": "Additional error-specific detail (e.g. blocking_command_id for device_locked)",
          "type": [
            "object",
            "null"
          ]
        },
        "message": {
          "description": "Human-readable error message",
          "type": "string"
        },
        "retryable": {
          "description": "Whether the caller may retry the request as-is",
          "type": "boolean"
        }
      },
      "required": [
        "code",
        "message",
        "retryable"
      ],
      "type": "object"
    }
  }
}