Partager via


Sensors - Create Or Update

Créez une entité de capteur.

PATCH {endpoint}/sensor-partners/{sensorPartnerId}/sensors/{sensorId}?api-version=2023-11-01-preview

Paramètres URI

Nom Dans Obligatoire Type Description
endpoint
path True

string

uri

Nom d’hôte de l’espace de noms, par exemple admaInstanceName.farmbeats.azure.net

sensorId
path True

string

ID de la ressource de capteur.

sensorPartnerId
path True

string

ID du partenaire de capteur.

api-version
query True

string

Version de l’API demandée

En-tête de la demande

Media Types: "application/merge-patch+json"

Nom Obligatoire Type Description
Authorization True

string

Fournissez un jeton de porteur valide pour les appels d’API autorisés. Notez que vous devrez peut-être effacer le cache de votre navigateur si vous avez déjà essayé des appels non authentifiés.

Corps de la demande

Media Types: "application/merge-patch+json"

Nom Type Description
depthInMeters

number[]

Profondeur de chaque mesure de capteur en mètres. Comme l’humidité du capteur à 2m, 4m, 6m.

description

string

Description textuelle de la ressource.

deviceId

string

ID de l’appareil associé.

hardwareId

string

ID du matériel associé.

integrationId

string

ID d’intégration pour l’appareil.

location

Location

Classe de modèle d’emplacement.

name

string

Nom destiné à identifier la ressource.

port

Port

Schéma pour le stockage des valeurs de port.

properties

Collection de paires clé-valeur qui appartient à la ressource. Chaque paire ne doit pas avoir une clé supérieure à 50 caractères et ne doit pas avoir une valeur supérieure à 150 caractères. Remarque : Un maximum de 25 paires de valeur de clé peut être fourni pour une ressource et seules les valeurs string, numeral et datetime (aaaa-MM-ddTHH :mm :ssZ) sont prises en charge.

sensorDataModelId

string

ID du modèle de données de capteur associé.

status

string

État de la ressource.

type

string

Type de capteur.

Réponses

Nom Type Description
200 OK

Sensor

Succès

201 Created

Sensor

Date de création

Other Status Codes

ErrorResponse

Error

En-têtes

x-ms-error-code: string

Sécurité

Authorization

Fournissez un jeton de porteur valide pour les appels d’API autorisés. Notez que vous devrez peut-être effacer le cache de votre navigateur si vous avez déjà essayé des appels non authentifiés.

Type: apiKey
Dans: header

Exemples

Sensors_CreateOrUpdate

Exemple de requête

PATCH {endpoint}/sensor-partners/sp1/sensors/s124?api-version=2023-11-01-preview

{
  "sensorDataModelId": "sdm124",
  "integrationId": "string",
  "hardwareId": "SMHD 456",
  "deviceId": "d124",
  "type": "SM",
  "location": {
    "latitude": 23.5,
    "longitude": 42.7
  },
  "port": {
    "name": "measure",
    "type": "digital"
  },
  "status": "sm created",
  "name": "my new sm",
  "description": "description for sensor goes here",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

Exemple de réponse

{
  "sensorDataModelId": "sdm124",
  "integrationId": "string",
  "hardwareId": "SMHD-456",
  "deviceId": "d124",
  "type": "SM",
  "location": {
    "latitude": 23.5,
    "longitude": 42.7
  },
  "port": {
    "name": "measure",
    "type": "digital"
  },
  "sensorPartnerId": "sp1",
  "id": "s124",
  "status": "sm created",
  "createdDateTime": "2022-01-24T06:27:05Z",
  "modifiedDateTime": "2022-01-24T06:27:05Z",
  "eTag": "040139eb-0000-0700-0000-61ee46b90000",
  "name": "my new sm",
  "description": "description for sensor goes here",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}
{
  "sensorDataModelId": "sdm124",
  "integrationId": "string",
  "hardwareId": "SMHD-456",
  "deviceId": "d124",
  "type": "SM",
  "location": {
    "latitude": 23.5,
    "longitude": 42.7
  },
  "port": {
    "name": "measure",
    "type": "digital"
  },
  "sensorPartnerId": "sp1",
  "id": "s124",
  "status": "sm created",
  "createdDateTime": "2022-01-24T06:27:05Z",
  "modifiedDateTime": "2022-01-24T06:27:05Z",
  "eTag": "040139eb-0000-0700-0000-61ee46b90000",
  "name": "my new sm",
  "description": "description for sensor goes here",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

Définitions

Nom Description
Error

Erreur du service Azure AgPlatform.

ErrorResponse

Réponse d’erreur du service Azure AgPlatform. Consultez https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses le document de référence ErrorResponse.

InnerError

Erreur interne contenant la liste des erreurs. Consultez https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object le document de référence InnerError.

Location

Classe de modèle d’emplacement.

Port

Schéma pour le stockage des valeurs de port.

Sensor

Modèle d’API de capteur.

Error

Erreur du service Azure AgPlatform.

Nom Type Description
code

string

Ensemble de codes d’erreur définis par le serveur.

details

Error[]

Tableau de détails sur les erreurs spécifiques qui ont conduit à cette erreur signalée.

innererror

InnerError

Erreur interne contenant la liste des erreurs. Consultez https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object le document de référence InnerError.

message

string

Représentation contrôlable de visu de l’erreur.

target

string

Cible de l’erreur.

ErrorResponse

Réponse d’erreur du service Azure AgPlatform. Consultez https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses le document de référence ErrorResponse.

Nom Type Description
error

Error

Erreur du service Azure AgPlatform.

traceId

string

ID de trace unique.

InnerError

Erreur interne contenant la liste des erreurs. Consultez https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object le document de référence InnerError.

Nom Type Description
code

string

Code d’erreur spécifique fourni par l’erreur contenant.

innererror

InnerError

Erreur interne contenant la liste des erreurs. Consultez https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object le document de référence InnerError.

Location

Classe de modèle d’emplacement.

Nom Type Description
latitude

number

Latitude de l’emplacement.

longitude

number

Longitude de l’emplacement.

Port

Schéma pour le stockage des valeurs de port.

Nom Type Description
name

string

Nom du port.

type

string

Type de port numérique/analogique.

Sensor

Modèle d’API de capteur.

Nom Type Description
createdBy

string

Créé par l’ID utilisateur/locataire.

createdDateTime

string

Date/Heure de création de la ressource, exemple de format : aaaa-MM-jjTHH:mm:ssZ.

depthInMeters

number[]

Profondeur de chaque mesure de capteur en mètres. Comme l’humidité du capteur à 2m, 4m, 6m.

description

string

Description textuelle de la ressource.

deviceId

string

ID de l’appareil associé.

eTag

string

Valeur ETag pour implémenter l’accès concurrentiel optimiste.

hardwareId

string

ID du matériel associé.

id

string

ID de la ressource.

integrationId

string

ID d’intégration pour l’appareil.

location

Location

Classe de modèle d’emplacement.

modifiedBy

string

Modifié par l’ID utilisateur/locataire.

modifiedDateTime

string

Date/Heure de la dernière modification de la ressource, exemple de format : aaaa-MM-jjTHH:mm:ssZ.

name

string

Nom destiné à identifier la ressource.

port

Port

Schéma pour le stockage des valeurs de port.

properties

Collection de paires clé-valeur qui appartient à la ressource. Chaque paire ne doit pas avoir une clé supérieure à 50 caractères et ne doit pas avoir une valeur supérieure à 150 caractères. Remarque : Un maximum de 25 paires de valeur de clé peut être fourni pour une ressource et seules les valeurs string, numeral et datetime (aaaa-MM-ddTHH :mm :ssZ) sont prises en charge.

sensorDataModelId

string

ID du modèle de données de capteur associé.

sensorPartnerId

string

ID du partenaire de capteur associé.

status

string

État de la ressource.

type

string

Type de capteur.