Farm Equipments - Create Or Update

Service:: Azure Data Manager for Agriculture

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

Crée ou met à jour une ressource d’équipement de batterie de serveurs.

PATCH {endpoint}/farm-equipments/{farmEquipmentId}?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
farmEquipmentId	path	True	string	ID de la ressource d’équipement de la batterie de serveurs.
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 essayé des appels non authentifiés avant.

Corps de la demande

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

Nom	Type	Description
brand	string	Marque commerciale du produit chimique.
company	Company	Détails de l’entreprise/fabricant.
cropIds	string[]	Les ID des cultures associées au produit chimique. Remarque : Un maximum de 25 cultures peuvent être associées à un cropProduct.
description	string minLength: 0 maxLength: 500	Description textuelle de la ressource.
location	string	Zone où l’équipement est utilisé.
model	string	Numéro de modèle de l’équipement agricole.
name	string minLength: 0 maxLength: 100	Nom pour identifier la ressource.
ownership	string	Propriété, louée, partagée, etc.
properties		Collection de paires clé-valeur qui appartient à la ressource. Chaque paire ne doit pas avoir de clé supérieure à 50 caractères et ne doit pas avoir de valeur supérieure à 150 caractères. Remarque : Un maximum de 25 paires clé-valeur peuvent être fournies pour une ressource et uniquement des valeurs chaîne, numération et datetime (aaaa-MM-jjTHH :mm :ssZ) sont prises en charge.
reference	Reference	Référence à un enregistrement de jeu de données.
serial	string	Numéro de série de l’équipement agricole.
series	string	Numéro de série de l’équipement agricole.
source	string minLength: 2 maxLength: 100	Source de la ressource.
status	string minLength: 0 maxLength: 100	État de la ressource.
type	string	Type de l’équipement agricole (Tiller, Tond, récolteur, Pulvérisateur, ...).

Réponses

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

Nom

Type

Description

200 OK

FarmEquipment

Succès

201 Created

FarmEquipment

Date de création

Other Status Codes

ErrorResponse

Erreur

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 essayé des appels non authentifiés avant.

Type: apiKey
Dans: header

Exemples

FarmEquipments_CreateOrUpdate

Exemple de requête

HTTP

PATCH {endpoint}/farm-equipments/Equipment123?api-version=2023-11-01-preview

{
  "cropIds": [
    "CropId"
  ],
  "reference": {
    "datasetId": "datasetId",
    "recordId": "recordId"
  },
  "brand": "string",
  "series": "H",
  "model": "1234",
  "serial": "1234",
  "type": "Harvester",
  "ownership": "Personal",
  "location": "US",
  "company": {
    "name": "Company123",
    "description": "Equipment manufacturer",
    "registrationNumber": "1234"
  },
  "status": "Active",
  "source": "Manufacturer",
  "name": "Equipment1",
  "description": "string",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

Exemple de réponse

Code d’état:: 200

{
  "id": "Equipment123",
  "cropIds": [
    "CropId"
  ],
  "reference": {
    "datasetId": "datasetId",
    "recordId": "recordId"
  },
  "brand": "string",
  "series": "H",
  "model": "1234",
  "serial": "1234",
  "type": "Harvester",
  "ownership": "Personal",
  "location": "US",
  "company": {
    "name": "Company123",
    "description": "Equipment manufacturer",
    "registrationNumber": "1234"
  },
  "status": "Active",
  "source": "Manufacturer",
  "name": "Equipment1",
  "description": "string",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  },
  "createdDateTime": "2021-04-21T06:49:30Z",
  "modifiedDateTime": "2021-04-21T06:49:30Z",
  "createdBy": "00000000-0000-0000-0000-000000000000",
  "modifiedBy": "00000000-0000-0000-0000-000000000000",
  "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e"
}

Code d’état:: 201

{
  "id": "Equipment123",
  "cropIds": [
    "CropId"
  ],
  "reference": {
    "datasetId": "datasetId",
    "recordId": "recordId"
  },
  "brand": "string",
  "series": "H",
  "model": "1234",
  "serial": "1234",
  "type": "Harvester",
  "ownership": "Personal",
  "location": "US",
  "company": {
    "name": "Company123",
    "description": "Equipment manufacturer",
    "registrationNumber": "1234"
  },
  "status": "Active",
  "source": "Manufacturer",
  "name": "Equipment1",
  "description": "string",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  },
  "createdDateTime": "2021-04-21T06:49:30Z",
  "modifiedDateTime": "2021-04-21T06:49:30Z",
  "createdBy": "00000000-0000-0000-0000-000000000000",
  "modifiedBy": "00000000-0000-0000-0000-000000000000",
  "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e"
}

Définitions

Nom	Description
Company	Détails de l’entreprise/fabricant.
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 pour le document de référence ErrorResponse.
FarmEquipment	Schéma de la ressource FarmEquipment.
InnerError	Erreur interne contenant la liste des erreurs. Consultez https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object pour le document de référence InnerError.
Reference	Référence à un enregistrement de jeu de données.

Company

Object

Détails de l’entreprise/fabricant.

Nom	Type	Description
description	string	Description de la société de fabrication.
name	string	Nom de l’entreprise de fabrication.
registrationNumber	string	Numéro d’inscription de l’entreprise.

Error

Object

Erreur du service Azure AgPlatform.

Nom	Type	Description
code	string minLength: 1	Ensemble défini par le serveur de codes d’erreur.
details	Error[]	Tableau de détails sur des 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 pour le document de référence InnerError.
message	string minLength: 1	Représentation lisible par l’homme de l’erreur.
target	string	Cible de l’erreur.

ErrorResponse

Object

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

Nom	Type	Description
error	Error	Erreur du service Azure AgPlatform.
traceId	string	ID de trace unique.

FarmEquipment

Object

Schéma de la ressource FarmEquipment.

Nom	Type	Description
brand	string	Marque commerciale du produit chimique.
company	Company	Détails de l’entreprise/fabricant.
createdBy	string	Créé par l’ID utilisateur/locataire.
createdDateTime	string (date-time)	Date et heure de création de la ressource, exemple de format : aaaa-MM-ddTHH :mm :ssZ.
cropIds	string[]	Les ID des cultures associées au produit chimique. Remarque : Un maximum de 25 cultures peuvent être associées à un cropProduct.
description	string minLength: 0 maxLength: 500	Description textuelle de la ressource.
eTag	string	Valeur ETag pour implémenter l’accès concurrentiel optimiste.
id	string	ID de ressource unique.
location	string	Zone où l’équipement est utilisé.
model	string	Numéro de modèle de l’équipement agricole.
modifiedBy	string	Modifié par l’ID utilisateur/locataire.
modifiedDateTime	string (date-time)	Date et heure de la dernière modification de la ressource, exemple de format : aaaa-MM-ddTHH :mm :ssZ.
name	string minLength: 0 maxLength: 100	Nom pour identifier la ressource.
ownership	string	Propriété, louée, partagée, etc.
properties		Collection de paires clé-valeur qui appartient à la ressource. Chaque paire ne doit pas avoir de clé supérieure à 50 caractères et ne doit pas avoir de valeur supérieure à 150 caractères. Remarque : Un maximum de 25 paires clé-valeur peuvent être fournies pour une ressource et uniquement des valeurs chaîne, numération et datetime (aaaa-MM-jjTHH :mm :ssZ) sont prises en charge.
reference	Reference	Référence à un enregistrement de jeu de données.
serial	string	Numéro de série de l’équipement agricole.
series	string	Numéro de série de l’équipement agricole.
source	string minLength: 2 maxLength: 100	Source de la ressource.
status	string minLength: 0 maxLength: 100	État de la ressource.
type	string	Type de l’équipement agricole (Tiller, Tond, récolteur, Pulvérisateur, ...).

InnerError

Object

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

Nom	Type	Description
code	string	Code d’erreur spécifique que fourni par l’erreur contenante.
innererror	InnerError	Erreur interne contenant la liste des erreurs. Consultez https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object pour le document de référence InnerError.

Reference

Object

Référence à un enregistrement de jeu de données.

Nom	Type	Description
datasetId	string minLength: 0 maxLength: 100	ID du jeu de données.
recordId	string minLength: 0 maxLength: 100	ID d’enregistrement.

Partager via

Farm Equipments - Create Or Update

Paramètres URI

En-tête de la demande

Corps de la demande

Réponses

Sécurité

Authorization

Exemples

FarmEquipments_CreateOrUpdate

Exemple de requête

Exemple de réponse

Définitions

Company

Error

ErrorResponse

FarmEquipment

InnerError

Reference