Sensor Data Models - Create Or Update

Référence

Service:: Azure Data Manager for Agriculture

Version d'API:: 2023-11-01-preview

Créez une entité de modèle de données de capteur.

PATCH {endpoint}/sensor-partners/{sensorPartnerId}/sensor-data-models/{sensorDataModelId}?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
sensorDataModelId	path	True	string	ID du modèle de données du 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	Obligatoire	Type	Description
measures	True	<string, SensorDataModelMeasure>	Mapper le type de capteur aux mesures du capteur.
description		string	Description textuelle de la ressource.
manufacturer		string	Fabricant du capteur.
name		string	Nom destiné à identifier la ressource.
productCode		string	Sensor productCode.
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.
status		string	État de la ressource.
type		string	Type de capteur.

Réponses

Nom	Type	Description
200 OK	SensorDataModel	Succès
201 Created	SensorDataModel	Date de création
Other Status Codes	ErrorResponse	Error En-têtes x-ms-error-code: string

Nom

Type

Description

200 OK

SensorDataModel

Succès

201 Created

SensorDataModel

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

SensorDataModels_CreateOrUpdate

Exemple de requête

HTTP

PATCH {endpoint}/sensor-partners/sp1/sensor-data-models/sdm124?api-version=2023-11-01-preview

{
  "type": "Sensor",
  "manufacturer": "Some sensor manufacturer",
  "productCode": "soil m",
  "measures": {
    "soilMoisture": {
      "description": "measures soil moisture",
      "dataType": "Bool",
      "type": "sm",
      "unit": "none",
      "properties": {
        "abc": "def",
        "elevation": 5
      }
    }
  },
  "status": "new",
  "name": "my sdm for soil moisture",
  "description": "description goes here",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

Exemple de réponse

Code d’état:: 200

{
  "type": "Sensor",
  "manufacturer": "Some sensor manufacturer",
  "productCode": "soil m",
  "measures": {
    "soilMoisture": {
      "description": "measures soil moisture",
      "dataType": "Bool",
      "type": "sm",
      "unit": "none",
      "properties": {
        "abc": "def",
        "elevation": 5
      }
    }
  },
  "sensorPartnerId": "sp1",
  "id": "sdm124",
  "status": "new",
  "createdDateTime": "2022-01-24T06:12:15Z",
  "modifiedDateTime": "2022-01-24T06:12:42Z",
  "eTag": "040161a2-0000-0700-0000-61ee435a0000",
  "name": "my sdm for soil moisture",
  "description": "description goes here",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

Code d’état:: 201

{
  "type": "Sensor",
  "manufacturer": "Some sensor manufacturer",
  "productCode": "soil m",
  "measures": {
    "soilMoisture": {
      "description": "measures soil moisture",
      "dataType": "Bool",
      "type": "sm",
      "unit": "none",
      "properties": {
        "abc": "def",
        "elevation": 5
      }
    }
  },
  "sensorPartnerId": "sp1",
  "id": "sdm124",
  "status": "new",
  "createdDateTime": "2022-01-24T06:12:15Z",
  "modifiedDateTime": "2022-01-24T06:12:15Z",
  "eTag": "040158a0-0000-0700-0000-61ee433f0000",
  "name": "my sdm for soil moisture",
  "description": "description 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.
SensorDataModel	Modèle d’API SensorModel.
SensorDataModelMeasure	Détails de la mesure du modèle de capteur.
SensorDataType	Type de données de mesure du 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.

SensorDataModel

Modèle d’API SensorModel.

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.
description	string	Description textuelle de la ressource.
eTag	string	Valeur ETag pour implémenter l’accès concurrentiel optimiste.
id	string	ID de la ressource.
manufacturer	string	Fabricant du capteur.
measures	<string, SensorDataModelMeasure>	Mapper le type de capteur aux mesures du capteur.
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.
productCode	string	Sensor productCode.
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.
sensorPartnerId	string	ID du partenaire de capteur associé.
status	string	État de la ressource.
type	string	Type de capteur.

SensorDataModelMeasure

Détails de la mesure du modèle de capteur.

Nom	Type	Description
dataType	SensorDataType	Type de données de mesure du capteur.
description	string	Description de la mesure du capteur.
properties		Collection de paires clé-valeur pour le modèle de données de capteur. 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 clé-valeur peut être fournie pour un modèle, et seules les valeurs chaîne, chiffre et datetime (aaaa-MM-jjTHH :mm :ssZ) sont prises en charge.
type	string	Type de mesure des données de capteur.
unit	string	Unité de mesure du capteur.

SensorDataType

Type de données de mesure du capteur.

Nom	Type	Description
Bool	string
DateTime	string
Double	string
Long	string
String	string

Partager via

Sensor Data Models - Create Or Update

Paramètres URI

En-tête de la demande

Corps de la demande

Réponses

Sécurité

Authorization

Exemples

SensorDataModels_CreateOrUpdate

Exemple de requête

Exemple de réponse

Définitions

Error

ErrorResponse

InnerError

SensorDataModel

SensorDataModelMeasure

SensorDataType

Ressources supplémentaires