Devices - Create Or Update

Référence

Service:: Azure Data Manager for Agriculture

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

Créez une entité d’appareil.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
deviceId	path	True	string	ID de la ressource d’appareil.
endpoint	path	True	string uri	Nom d’hôte de l’espace de noms, par exemple admaInstanceName.farmbeats.azure.net
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
description	string	Description textuelle de la ressource.
deviceDataModelId	string	ID du modèle de données d’appareil associé.
hardwareId	string	Device hardwareId.
integrationId	string	ID d’intégration pour l’appareil.
location	Location	Classe de modèle d’emplacement.
name	string	Nom destiné à identifier la ressource.
parentDeviceId	string	ID d’appareil parent pour cet appareil.
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.
reportingIntervalInSeconds	integer	Intervalle auquel l’appareil envoie des données en secondes.
status	string	État de la ressource.
type	string	Type d’appareil.

Réponses

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

Nom

Type

Description

200 OK

Device

Succès

201 Created

Device

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

Devices_CreateOrUpdate

Exemple de requête

HTTP

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

{
  "deviceDataModelId": "ddm124",
  "integrationId": "string",
  "type": "device",
  "hardwareId": "HD156",
  "reportingIntervalInSeconds": 10,
  "location": {
    "latitude": 23.5,
    "longitude": 42.7
  },
  "status": "new device",
  "name": "my device",
  "description": "description goes here",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

Exemple de réponse

Code d’état:: 200

{
  "deviceDataModelId": "ddm124",
  "integrationId": "string",
  "type": "device",
  "hardwareId": "HD156",
  "reportingIntervalInSeconds": 10,
  "location": {
    "latitude": 23.5,
    "longitude": 42.7
  },
  "sensorPartnerId": "sp1",
  "id": "d123",
  "status": "new device",
  "createdDateTime": "2022-01-24T06:20:47Z",
  "modifiedDateTime": "2022-01-24T06:21:07Z",
  "eTag": "0401a5cc-0000-0700-0000-61ee45540000",
  "name": "my device",
  "description": "description goes here",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

Code d’état:: 201

{
  "deviceDataModelId": "ddm124",
  "integrationId": "string",
  "type": "device",
  "hardwareId": "HD156",
  "reportingIntervalInSeconds": 10,
  "location": {
    "latitude": 23.5,
    "longitude": 42.7
  },
  "sensorPartnerId": "sp1",
  "id": "d123",
  "status": "new device",
  "createdDateTime": "2022-01-24T06:20:47Z",
  "modifiedDateTime": "2022-01-24T06:20:47Z",
  "eTag": "0401baca-0000-0700-0000-61ee453f0000",
  "name": "my device",
  "description": "description goes here",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

Définitions

Nom	Description
Device	Modèle d’API d’appareil.
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.

Device

Modèle d’API d’appareil.

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.
deviceDataModelId	string	ID du modèle de données d’appareil associé.
eTag	string	Valeur ETag pour implémenter l’accès concurrentiel optimiste.
hardwareId	string	Device hardwareId.
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.
parentDeviceId	string	ID d’appareil parent pour cet appareil.
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.
reportingIntervalInSeconds	integer	Intervalle auquel l’appareil envoie des données en secondes.
sensorPartnerId	string	ID du partenaire de capteur associé.
status	string	État de la ressource.
type	string	Type d’appareil.

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.

Partager via

Devices - Create Or Update

Paramètres URI

En-tête de la demande

Corps de la demande

Réponses

Sécurité

Authorization

Exemples

Devices_CreateOrUpdate

Exemple de requête

Exemple de réponse

Définitions

Device

Error

ErrorResponse

InnerError

Location

Ressources supplémentaires