Capteur

Mis à jour le 4 septembre 2026APITélécharger le PDF

Utiliser avec une IA

Afficher en Markdown Ouvrir dans Claude Ouvrir dans ChatGPT

Suggérer une modification Obtenir de l’aide

Sur cette page

POST /sensor/
Corps de la requête
Réponses
POST /sensor/filter
Corps de la requête
Réponses
PUT /sensor/isolate?sensorId={sensorId}&enable={enable}
Paramètres
Réponses
POST /sensor/listBySiteIds
Corps de la demande
Réponses
POST /sensor/search
Corps de la demande
Réponses
GET /sensor/{id}
Paramètres
Réponses
PUT /sensor/{id}
Paramètres
Corps de la demande
Réponses
DELETE /sensor/{id}
Paramètres
Réponses
GET /sensor/{id}/streamingEndpoints
Paramètres
Réponses

Opérations sur les ressources du capteur. 9 points de terminaison, chacun relatif à https://api.nxgen.cloud/api/v1 et authentifié comme décrit sous Authentication.

POST /sensor/

CRÉER UN NOUVEAU Sensor

Corps de la requête

Ajouter un capteur

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

Réponses

Statut	Description	Corps
200	Succès
204	Pas de contenu
400	Entrée invalide
401	Non autorisé
403	Interdit

POST /sensor/filter

Obtient la liste des capteurs avec filtrage, tri et pagination. Permet la recherche par niveau hiérarchique. Peut être filtré en utilisant la hiérarchie spécifiée ou utilise la hiérarchie de l'utilisateur connecté. Cela offre la possibilité d'obtenir des champs d'entité supplémentaires dans la réponse. Fournit également les métadonnées de configuration de l'entité.

Corps de la requête

Filtrage et tri des capteurs

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

Réponses

Statut	Description	Corps
200	Succès	objet
204	Pas de contenu
400	Entrée invalide
401	Non autorisé
403	Interdit

Exemple 200 réponse:

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}

Mettre à jour l’isolation du capteur

Paramètres

Nom	Dans	Type	Obligatoire
sensorId	query	string	oui
enable	query	boolean	oui
isolateStartTime	query	number	non
duration	query	number	non

Réponses

Statut	Description	Corps
200	Succès
204	Pas de contenu
401	Non autorisé
403	Interdit
404	Pas trouvé

POST /sensor/listBySiteIds

Obtenir les capteurs par liste d’ID du site

Corps de la demande

Obtenir les capteurs

json

{
  "siteIds": [
    "string"
  ]
}

Réponses

Statut	Description	Corps
200	Succès	object
204	Pas de contenu
400	Entrée invalide
401	Non autorisé
403	Interdit

Exemple 200 réponse:

json

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

POST /sensor/search

Rechercher des capteurs

Corps de la demande

Rechercher des capteurs

json

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

Réponses

Statut	Description	Corps
200	Succès	object
400	Entrée invalide
401	Non autorisé
403	Interdit
404	Pas trouvé

Exemple 200 réponse:

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}

Obtenir par identifiant du capteur

Paramètres

Nom	Dans	Type	Obligatoire	Description
id	chemin	chaîne	oui

Réponses

Statut	Description	Corps
200	Succès
204	Pas de contenu
401	Non autorisé
403	Interdit
404	Pas trouvé

PUT /sensor/{id}

Mettre à jour un capteur existant

Paramètres

Nom	Dans	Type	Obligatoire	Description
id	path	string	oui

Corps de la demande

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

Réponses

Statut	Description	Corps
200	Succès
204	Pas de contenu
400	Entrée invalide
401	Non autorisé
403	Interdit

DELETE /sensor/{id}

Supprimer un capteur par id

Paramètres

Nom	Dans	Type	Obligatoire	Description
id	path	string	yes
forceDelete	query	string	no	forcer la suppression du capteur

Réponses

Statut	Description	Corps
200	Succès
204	Pas de contenu
400	Entrée invalide
401	Non autorisé
403	Interdit

GET /sensor/{id}/streamingEndpoints

Obtenir les points de diffusion

Paramètres

Nom	Dans	Type	Obligatoire	Description
id	chemin	chaîne	oui	Identifiant du capteur
heureDébut	requête	nombre	non	Temps epoch en millisecondes
heureFin	requête	nombre	non	Temps epoch en millisecondes
expiration	requête	nombre	non	En secondes

Réponses

Statut	Description	Corps
200	Succès
204	Aucun contenu
401	Non autorisé
403	Interdit
404	Introuvable

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

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