Sensor

Actualizado el 4 de septiembre de 2026APIDescargar PDF

Usar con IA

Ver como Markdown Abrir en Claude Abrir en ChatGPT

En esta página

POST /sensor/
Cuerpo de la Solicitud
Respuestas
POST /sensor/filter
Cuerpo de la Solicitud
Respuestas
PUT /sensor/isolate?sensorId={sensorId}&enable={enable}
Parámetros
Respuestas
POST /sensor/listBySiteIds
Cuerpo de la Solicitud
Respuestas
POST /sensor/search
Cuerpo de la Solicitud
Respuestas
GET /sensor/{id}
Parámetros
Respuestas
PUT /sensor/{id}
Parámetros
Cuerpo de la Solicitud
Respuestas
DELETE /sensor/{id}
Parámetros
Respuestas
GET /sensor/{id}/streamingEndpoints
Parámetros
Respuestas

Operaciones sobre recursos de sensor. 9 puntos finales, cada uno relativo a https://api.nxgen.cloud/api/v1 y autenticado según lo descrito en Authentication.

POST /sensor/

Crear un nuevo Sensor

Cuerpo de la Solicitud

Agregar un Sensor

json

{
  "payload": [
    {
      "id": "string",
      "siteEventProviderId": "string",
      "customerEventProviderId": "string",
      "customerId": "string",
      "serviceProvidersEventProviderId": "string",
      "associatedDeviceName": "string",
      "associatedDeviceId": "string",
      "catalogName": "string",
      "commercialName": "string (required)",
      "deviceType": "string",
      "sensorType": "string",
      "description": "string",
      "macAddress": "string",
      "modelNo": "string",
      "hardwareVersion": "string",
      "firmwareVersion": "string",
      "manafacturer": "string",
      "jsonSchema": "object",
      "photos": [
        "string"
      ],
      "specification": "string",
      "geoCordinates": {
        "latitude": "string",
        "longitude": "string",
        "plusCode": "string",
        "what3Words": "string"
      },
      "siteParent": "string",
      "siteId": "string",
      "assetStatus": "string",
      "tags": [
        "string"
      ],
      "eventTags": [
        "string"
      ],
      "channelId": "number",
      "type": "string",
      "syncStatus": "boolean",
      "isPtzCamera": "boolean",
      "isThermalCamera": "boolean"
    }
  ]
}

Respuestas

Estado	Descripción	Cuerpo
200	Éxito
204	Sin contenido
400	Entrada inválida
401	No autorizado
403	Prohibido

POST /sensor/filter

Obtiene la lista de sensores con filtrado, ordenación y paginación. Permite búsquedas por nivel jerárquico. Puede filtrarse usando la jerarquía especificada o utiliza la jerarquía del usuario autenticado. Esto brinda la opción de obtener campos de entidad adicionales en la respuesta. También proporciona metadatos de configuración sobre la entidad.

Cuerpo de la Solicitud

Filtrado y ordenación de sensores

json

{
  "filters": [
    {
      "columnName": "string (required)",
      "type": "distinctList | date | number | StringConditionFilter (required)",
      "filter": "object (required)"
    }
  ],
  "sortOrder": [
    {
      "columnName": "string",
      "isAscending": "boolean"
    }
  ],
  "primaryColumns": [
    "string"
  ],
  "hierarchyLevel": "string",
  "hierarchyId": "string",
  "nPerPage": "number",
  "pageNumber": "number",
  "isConfigDetailRequired": "boolean",
  "getConfig": "boolean",
  "getChildOrParent": "boolean"
}

Respuestas

Estado	Descripción	Cuerpo
200	Éxito	objeto
204	Sin contenido
400	Entrada inválida
401	No autorizado
403	Prohibido

Ejemplo 200 respuesta:

json

{
  "config": {
    "columns": [
      {
        "visibility": true,
        "columnName": "commercialName",
        "DisplayName": "Sensor",
        "isFilterable": true,
        "filterType": "stringCondition",
        "sticky": true,
        "isRightBorder": true,
        "isMandatory": true,
        "isNotDraggable": true
      }
    ],
    "defaultNPerPage": 50,
    "defaultFilterCondition": [],
    "defaultSortingOrder": [
      {
        "columnName": "dateTime",
        "isAscending": false
      }
    ],
    "maxVisibleColumnCount": 6,
    "exportLimitNPerPage": 500
  },
  "dataResult": [
    {
      "commercialName": "Camera 01",
      "assetStatus": "active",
      "enableAudio": "Disabled",
      "manafacturer": "HSION",
      "uniqueId": "b89e4e809ce547f01234567eba36f825",
      "dateTime": 1648453119079,
      "associatedDeviceId": "e5560be4e809ce547f012547f76547f01234",
      "associatedDeviceName": "Device"
    },
    {
      "commercialName": "Camera 03",
      "assetStatus": "active",
      "enableAudio": "Disabled",
      "manafacturer": "HSION",
      "uniqueId": "p05e4e107ce547f7654321eba36f790",
      "dateTime": 1648453119079,
      "associatedDeviceId": "561eba3591c690ed03c4547f0123456345c4",
      "associatedDeviceName": "Device"
    }
  ],
  "totalRecordsCount": 3552,
  "filteredBy": [],
  "sortedBy": [
    {
      "columnName": "dateTime",
      "isAscending": false
    }
  ],
  "dispatchedAll": false,
  "isDefaultProjectionMutated": false,
  "isDefaultFilterMutated": false,
  "isDefaultSortingMutated": false
}

PUT /sensor/isolate?sensorId={sensorId}&enable={enable}

Actualizar aislamiento para sensor

Parámetros

Nombre	En	Tipo	Obligatorio
sensorId	consulta	cadena	sí
enable	consulta	booleano	sí
isolateStartTime	consulta	número	no
duration	consulta	número	no

Respuestas

Estado	Descripción	Cuerpo
200	Éxito
204	Sin contenido
401	No autorizado
403	Prohibido
404	No Encontrado

POST /sensor/listBySiteIds

Get sensores por lista de Site ID

Cuerpo de la Solicitud

Get sensores

json

{
  "siteIds": [
    "string"
  ]
}

Respuestas

Estado	Descripción	Cuerpo
200	Éxito	objeto
204	Sin contenido
400	Entrada inválida
401	No autorizado
403	Prohibido

Ejemplo 200 respuesta:

json

{
  "data": [
    {
      "key": "7f01237864567eba89736f825",
      "label": "sensor",
      "deviceId": "ce546437f01234567e6f825",
      "deviceName": "device",
      "siteName": "site",
      "customerName": "customer"
    }
  ]
}

POST /sensor/search

Buscar sensores

Cuerpo de la Solicitud

Buscar sensores

json

{
  "skip": "number",
  "limit": "number",
  "siteName": "string",
  "siteId": "string (required)",
  "sensorName": "string",
  "isAll": "boolean",
  "searchTag": [
    "string"
  ]
}

Respuestas

Estado	Descripción	Cuerpo
200	Éxito	objeto
400	Entrada inválida
401	No autorizado
403	Prohibido
404	No Encontrado

Ejemplo 200 respuesta:

json

{
  "data": [
    {
      "sensorId": "89d42e2953b8b5d662b3006bfdd444e",
      "name": "Camera 03",
      "isActive": true,
      "type": "camera",
      "mapInfo": {
        "latitude": "13.035775322405794",
        "longitude": "80.17819431590344",
        "plusCode": "25PH+87 Chennai, Tamil Nadu, India",
        "what3Words": "climbing.rested.alongside",
        "zone": ""
      }
    }
  ],
  "isSuccess": true
}

GET /sensor/{id}

Obtener por id del sensor

Parámetros

Nombre	En	Tipo	Obligatorio	Descripción
id	ruta	cadena	sí

Respuestas

Estado	Descripción	Cuerpo
200	Éxito
204	Sin contenido
401	No autorizado
403	Prohibido
404	No Encontrado

PUT /sensor/{id}

Actualizar un sensor existente

Parámetros

Nombre	En	Tipo	Obligatorio	Descripción
id	ruta	cadena	sí

Cuerpo de la Solicitud

json

{
  "payload": {
    "id": "string",
    "siteEventProviderId": "string",
    "customerEventProviderId": "string",
    "customerId": "string",
    "imageFile": "string",
    "serviceProvidersEventProviderId": "string",
    "associatedDeviceName": "string",
    "associatedDeviceId": "string",
    "catalogName": "string",
    "commercialName": "string (required)",
    "deviceType": "string",
    "sensorType": "string",
    "description": "string",
    "macAddress": "string",
    "modelNo": "string",
    "hardwareVersion": "string",
    "firmwareVersion": "string",
    "manafacturer": "string",
    "jsonSchema": "object",
    "jsonSchemaResult": "object",
    "eventTypes": [
      "object"
    ],
    "actionSupported": [
      "object"
    ],
    "photos": [
      "object"
    ],
    "photoSizeInPixel": [
      "object"
    ],
    "specification": "string",
    "assetId": "string",
    "prerequisite": [
      "object"
    ],
    "geoCordinates": {
      "latitude": "string",
      "longitude": "string",
      "plusCode": "string",
      "what3Words": "string",
      "zone": "string"
    },
    "siteParent": "string",
    "siteId": "string",
    "assetStatus": "string",
    "tags": [
      "string"
    ],
    "eventTags": [
      "string"
    ],
    "isInArmState": "boolean",
    "uniqueId": "string",
    "channelId": "number",
    "syncStatus": "boolean",
    "roiCoordinates": [
      [
        "number"
      ]
    ],
    "isIsolate": "boolean",
    "isolatedTime": "string",
    "isolateStartTime": "string",
    "isPtzCamera": "boolean",
    "isThermalCamera": "boolean",
    "enableAudio": "boolean",
    "timerMaskCoordinates": [
      [
        "number"
      ]
    ],
    "analyticsROI": [
      "object"
    ],
    "analytics": "object",
    "analyticsSPDefined": [
      "object"
    ]
  }
}

Respuestas

Estado	Descripción	Cuerpo
200	Éxito
204	Sin contenido
400	Entrada inválida
401	No autorizado
403	Prohibido

DELETE /sensor/{id}

Eliminar un sensor por id

Parámetros

Nombre	En	Tipo	Obligatorio	Descripción
id	ruta	cadena	sí
forceDelete	consulta	cadena	no	eliminar forzadamente el sensor

Respuestas

Estado	Descripción	Cuerpo
200	Éxito
204	Sin contenido
400	Entrada inválida
401	No autorizado
403	Prohibido

GET /sensor/{id}/streamingEndpoints

Obtener puntos finales de transmisión

Parámetros

Nombre	En	Tipo	Obligatorio	Descripción
id	ruta	cadena	sí	Identificador del sensor
startTime	consulta	número	no	Hora epoch en milisegundos
endTime	consulta	número	no	Hora epoch en milisegundos
expiry	consulta	número	no	En segundos

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.