GCXONEDocumentatie

Statusweergave

Op deze pagina
  1. PATCH /status/device/{id}
  2. Parameters
  3. Verzoek‑body
  4. Responsen
  5. PATCH /status/sensor/{id}
  6. Parameters
  7. Verzoek body
  8. Responsen

Operaties op statusweergave‑resources. 2 eindpunten, elk relatief ten opzichte van https://api.nxgen.cloud/api/v1 en geauthenticeerd zoals beschreven onder Authenticatie.

PATCH /status/device/{id}

Apparaatstatus bijwerken

Parameters

Naam

In

Type

Verplicht

Beschrijving

id

path

string

ja

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

Responsen

Status

Beschrijving

Body

200

Succes

204

Geen inhoud

401

Niet geautoriseerd

403

Verboden

404

Niet gevonden

PATCH /status/sensor/{id}

Sensorstatus bijwerken

Parameters

Naam

In

Type

Verplicht

Beschrijving

id

pad

string

ja

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

Responsen

Status

Beschrijving

Body

200

Succes

204

Geen inhoud

401

Niet geautoriseerd

403

Verboden

404

Niet gevonden

Was deze pagina nuttig?

Bedankt — uw feedback gaat naar het team dat deze pagina beheert.