GCXONEDocumentation

Vue d'état

Sur cette page
  1. PATCH /status/device/{id}
  2. Paramètres
  3. Corps de la demande
  4. Réponses
  5. PATCH /status/sensor/{id}
  6. Paramètres
  7. Corps de la demande
  8. Réponses

Opérations sur les ressources de la vue d'état. 2 points de terminaison, chacun relatif à https://api.nxgen.cloud/api/v1 et authentifié comme décrit sous Authentication.

PATCH /status/device/{id}

Mettre à jour le Statut du périphérique

Paramètres

Nom

Dans

Type

Obligatoire

Description

id

chemin

chaîne

oui

Corps de la demande

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"
      }
    }
  }
}

Réponses

Statut

Description

Corps

200

Succès

204

Pas de contenu

401

Non autorisé

403

Interdit

404

Pas trouvé

PATCH /status/sensor/{id}

Mettre à jour le Statut du capteur

Paramètres

Nom

Dans

Type

Obligatoire

Description

id

path

chaîne

oui

Corps de la demande

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"
      }
    }
  }
}

Réponses

Statut

Description

Corps

200

Succès

204

Pas de contenu

401

Non autorisé

403

Interdit

404

Pas trouvé

Cette page vous a-t-elle été utile ?

Merci — votre retour est transmis à l’équipe responsable de cette page.