GCXONEDocumentación

Vista de estado

En esta página
  1. PATCH /status/device/{id}
  2. Parámetros
  3. Cuerpo de la solicitud
  4. Respuestas
  5. PATCH /status/sensor/{id}
  6. Parámetros
  7. Cuerpo de la solicitud
  8. Respuestas

Operaciones sobre recursos de vista de estado. 2 endpoints, cada uno relativo a https://api.nxgen.cloud/api/v1 y autenticado como se describe en Authentication.

PATCH /status/device/{id}

Actualizar Estado del dispositivo

Parámetros

Nombre

En

Tipo

Obligatorio

Descripción

id

path

string

yes

Cuerpo de la solicitud

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

Respuestas

Estado

Descripción

Cuerpo

200

Éxito

204

Sin contenido

401

No autorizado

403

Prohibido

404

No Encontrado

PATCH /status/sensor/{id}

Actualizar Estado del sensor

Parámetros

Nombre

En

Tipo

Obligatorio

Descripción

id

ruta

cadena

Cuerpo de la solicitud

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

Respuestas

Estado

Descripción

Cuerpo

200

Éxito

204

Sin contenido

401

No autorizado

403

Prohibido

404

No Encontrado

¿Le ha resultado útil esta página?

Gracias — sus comentarios llegan al equipo responsable de esta página.