GCXONEDokumentation

Statusansicht

Auf dieser Seite
  1. PATCH /status/device/{id}
  2. Parameter
  3. Anfragetext
  4. Antworten
  5. PATCH /status/sensor/{id}
  6. Parameter
  7. Anfrage-Body
  8. Antworten

Operationen für Statusansichts‑Ressourcen. 2 Endpunkte, jeweils relativ zu https://api.nxgen.cloud/api/v1 und authentifiziert wie unter Authentifizierung.

PATCH /status/device/{id}

Gerätestatus aktualisieren

Parameter

Name

In

Typ

Erforderlich

Beschreibung

id

path

Zeichenkette

ja

Anfragetext

json
{
  "payload": {
    "status": {
      "CAMERA_ISOLATE": {
        "status": "string",
        "event": "string",
        "alarm": "boolean",
        "statusType": "string",
        "statusColor": "string",
        "statusIcon": "string",
        "statusText": "string"
      },
      "DISK_LOW": {
        "status": "string",
        "event": "string",
        "alarm": "boolean",
        "statusType": "string",
        "statusColor": "string",
        "statusIcon": "string",
        "statusText": "string"
      },
      "HEALTH_FAIL": {
        "status": "string",
        "event": "string",
        "alarm": "boolean",
        "statusType": "string",
        "statusColor": "string",
        "statusIcon": "string",
        "statusText": "string"
      },
      "conclusion": {
        "goodState": "boolean",
        "alertState": "string",
        "statusColor": "string"
      }
    }
  }
}

Antworten

Status

Beschreibung

Body

200

Erfolg

204

Kein Inhalt

401

Nicht autorisiert

403

Verboten

404

Nicht gefunden

PATCH /status/sensor/{id}

Sensortatus aktualisieren

Parameter

Name

In

Typ

Erforderlich

Beschreibung

ID

Pfad

Zeichenkette

ja

Anfrage-Body

json
{
  "payload": {
    "status": {
      "CAMERA_ISOLATE": {
        "status": "string",
        "event": "string",
        "alarm": "boolean",
        "statusType": "string",
        "statusColor": "string",
        "statusIcon": "string",
        "statusText": "string"
      },
      "DISK_LOW": {
        "status": "string",
        "event": "string",
        "alarm": "boolean",
        "statusType": "string",
        "statusColor": "string",
        "statusIcon": "string",
        "statusText": "string"
      },
      "HEALTH_FAIL": {
        "status": "string",
        "event": "string",
        "alarm": "boolean",
        "statusType": "string",
        "statusColor": "string",
        "statusIcon": "string",
        "statusText": "string"
      },
      "conclusion": {
        "goodState": "boolean",
        "alertState": "string",
        "statusColor": "string"
      }
    }
  }
}

Antworten

Status

Beschreibung

Inhalt

200

Erfolg

204

Kein Inhalt

401

Nicht autorisiert

403

Verboten

404

Nicht gefunden

War diese Seite hilfreich?

Vielen Dank — Ihr Feedback geht an das Team, das diese Seite betreut.