Fields - Create Or Update

Referenz

Dienst:: Azure Data Manager for Agriculture

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

Erstellt oder Updates eine Feldressource unter einer bestimmten Partei.

PATCH {endpoint}/parties/{partyId}/fields/{fieldId}?api-version=2023-11-01-preview

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string uri	Der Hostname des Namespace, z. B. admaInstanceName.farmbeats.azure.net
fieldId	path	True	string	ID der Feldressource.
partyId	path	True	string	ID der zugeordneten Parteiressource.
api-version	query	True	string	Die angeforderte API-Version

Anforderungsheader

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

Name	Erforderlich	Typ	Beschreibung
Authorization	True	string	Geben Sie ein gültiges Bearertoken für autorisierte API-Aufrufe an. Beachten Sie, dass Sie möglicherweise Ihren Browsercache löschen müssen, wenn Sie zuvor nicht authentifizierte Aufrufe ausprobiert haben.

Anforderungstext

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

Name	Typ	Beschreibung
description	string	Textbeschreibung der Ressource.
farmId	string	ID der zugeordneten Farm.
geometry	GeoJsonObject: MultiPolygon Point Polygon	GeoJSON (Weitere Informationen: https://geojson.org/). Hinweis: Koordinaten werden im Format [Längengrad, Breitengrad] erwartet.
name	string	Der Name zur Identifizierung der Ressource.
properties		Eine Sammlung von Schlüsselwertpaaren, die zur Ressource gehören. Jedes Paar darf keinen Schlüssel größer als 50 Zeichen haben und darf keinen Wert größer als 150 Zeichen haben. Hinweis: Für eine Ressource können maximal 25 Schlüsselwertpaare bereitgestellt werden, und es werden nur Zeichenfolgen-, Zahlen- und Datetime-Werte (JJJJ-MM-ddTHH:mm:ssZ) unterstützt.
source	string	Quelle der Ressource.
status	string	Status der Ressource.

Antworten

Name	Typ	Beschreibung
200 OK	Field	Erfolg
201 Created	Field	Erstellt
Other Status Codes	ErrorResponse	Fehler Header x-ms-error-code: string

Name

Typ

Beschreibung

200 OK

Field

Erfolg

201 Created

Field

Erstellt

Other Status Codes

ErrorResponse

Fehler

Header

x-ms-error-code: string

Sicherheit

Authorization

Geben Sie ein gültiges Bearertoken für autorisierte API-Aufrufe an. Beachten Sie, dass Sie möglicherweise Ihren Browsercache löschen müssen, wenn Sie zuvor nicht authentifizierte Aufrufe ausprobiert haben.

Typ: apiKey
In: header

Beispiele

Fields_CreateOrUpdate

Beispielanforderung

HTTP

PATCH {endpoint}/parties/PARTY123/fields/FIELD123?api-version=2023-11-01-preview

{
  "farmId": "FARM123",
  "status": "Active",
  "name": "John Smith's Field",
  "description": "Some description",
  "source": "source",
  "properties": {
    "Irrigated": "Yes",
    "RetailerId": "Retailer123"
  }
}

Beispiel für eine Antwort

Statuscode:: 200

{
  "id": "FIELD123",
  "partyId": "PARTY123",
  "farmId": "FARM123",
  "name": "John Smith's Field",
  "status": "Active",
  "description": "Some description",
  "source": "source",
  "properties": {
    "Irrigated": "Yes",
    "RetailerId": "Retailer123"
  },
  "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"
}

Statuscode:: 201

{
  "id": "FIELD123",
  "partyId": "PARTY123",
  "farmId": "FARM123",
  "name": "John Smith's Field",
  "status": "Active",
  "description": "Some description",
  "source": "source",
  "properties": {
    "Irrigated": "Yes",
    "RetailerId": "Retailer123"
  },
  "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"
}

Definitionen

Name	Beschreibung
Error	Ein Fehler des Azure AgPlatform-Diensts.
ErrorResponse	Eine Fehlerantwort des Azure AgPlatform-Diensts. Weitere Informationen finden Sie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses unter ErrorResponse-Referenzdokument.
Field	Schema der Feldressource.
GeoJsonObjectType	GeoJSON-Objekttyp.
InnerError	Innerer Fehler, der eine Fehlerliste enthält. Weitere Informationen finden Sie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object unter InnerError-Referenzdokument.
MultiPolygon	MultiPolygon-Geometrie.
Point	Punktgeometrie.
Polygon	Polygongeometrie.

Error

Ein Fehler des Azure AgPlatform-Diensts.

Name	Typ	Beschreibung
code	string	Vom Server definierte Gruppe von Fehlercodes.
details	Error[]	Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	InnerError	Innerer Fehler, der eine Fehlerliste enthält. Weitere Informationen finden Sie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object unter InnerError-Referenzdokument.
message	string	Lesbare Darstellung des Fehlers.
target	string	Ziel des Fehlers.

ErrorResponse

Eine Fehlerantwort des Azure AgPlatform-Diensts. Weitere Informationen finden Sie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses unter ErrorResponse-Referenzdokument.

Name	Typ	Beschreibung
error	Error	Ein Fehler des Azure AgPlatform-Diensts.
traceId	string	Eindeutige Ablaufverfolgungs-ID.

Field

Schema der Feldressource.

Name	Typ	Beschreibung
createdBy	string	Erstellt von Benutzer-/Mandanten-ID.
createdDateTime	string	Datum und Uhrzeit der Erstellung der Ressource, Beispielformat: jjjj-MM-ttTHH:mm:ssZ.
description	string	Textbeschreibung der Ressource.
eTag	string	Der ETag-Wert, um eine optimistische Parallelität zu implementieren.
farmId	string	ID der zugeordneten Farm.
geometry	GeoJsonObject: MultiPolygon Point Polygon	GeoJSON (Weitere Informationen: https://geojson.org/). Hinweis: Koordinaten werden im Format [Längengrad, Breitengrad] erwartet.
id	string	Eindeutige Ressourcen-ID.
modifiedBy	string	Geändert durch Benutzer-/Mandanten-ID.
modifiedDateTime	string	Datum und Uhrzeit der letzten Änderung der Ressource, Beispielformat: jjjj-MM-ttTHH:mm:ssZ.
name	string	Der Name zur Identifizierung der Ressource.
partyId	string	Partei-ID.
properties		Eine Sammlung von Schlüsselwertpaaren, die zur Ressource gehören. Jedes Paar darf keinen Schlüssel größer als 50 Zeichen haben und darf keinen Wert größer als 150 Zeichen haben. Hinweis: Für eine Ressource können maximal 25 Schlüsselwertpaare bereitgestellt werden, und es werden nur Zeichenfolgen-, Zahlen- und Datetime-Werte (JJJJ-MM-ddTHH:mm:ssZ) unterstützt.
source	string	Quelle der Ressource.
status	string	Status der Ressource.

GeoJsonObjectType

GeoJSON-Objekttyp.

Name	Typ	Beschreibung
MultiPolygon	string
Point	string
Polygon	string

InnerError

Innerer Fehler, der eine Fehlerliste enthält. Weitere Informationen finden Sie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object unter InnerError-Referenzdokument.

Name	Typ	Beschreibung
code	string	Spezifischer Fehlercode als vom enthaltenden Fehler bereitgestellt wurde.
innererror	InnerError	Innerer Fehler, der eine Fehlerliste enthält. Weitere Informationen finden Sie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object unter InnerError-Referenzdokument.

MultiPolygon

MultiPolygon-Geometrie.

Name	Typ	Beschreibung
coordinates	number[]	Ruft Koordinaten des GeoJSON-Objekts ab oder legt diese fest. Es muss sich um ein Array von Polygonen handeln, wobei jedes Polygon eine Liste von linearen Ringen enthält. Bei Polygonen mit mehr als einem dieser Ringe MUSS der erste der äußere Ring sein, und alle anderen MÜSSEN Innenringe sein.
type	string: MultiPolygon	GeoJSON-Objekttyp.

Point

Punktgeometrie.

Name	Typ	Beschreibung
coordinates	number[]	Ruft die Koordinate dieses Punkts ab oder legt sie fest. Es muss ein Array von 2 oder 3 Elementen für ein 2D- oder 3D-System sein.
type	string: Point	GeoJSON-Objekttyp.

Polygon

Polygongeometrie.

Name	Typ	Beschreibung
coordinates	number[]	Ruft den Typ des GeoJSON-Objekts ab oder legt diese fest. Es muss sich um ein Array linearer Ringkoordinatenarrays handelt. Bei Polygonen mit mehr als einem dieser Ringe MUSS der erste der äußere Ring sein, und alle anderen MÜSSEN Innenringe sein.
type	string: Polygon	GeoJSON-Objekttyp.

Freigeben über

Fields - Create Or Update

URI-Parameter

Anforderungsheader

Anforderungstext

Antworten

Sicherheit

Authorization

Beispiele

Fields_CreateOrUpdate

Beispielanforderung

Beispiel für eine Antwort

Definitionen

Error

ErrorResponse

Field

GeoJsonObjectType

InnerError

MultiPolygon

Point

Polygon

Zusätzliche Ressourcen