Fields - Get

Abrufen einer angegebenen Feldressource für einen bestimmten Feldeintrag.

GET /farmers/{farmerId}/fields/{fieldId}?api-version=2021-03-31-preview

URI-Parameter

Name In Required Type Description
farmerId
path True
  • string

ID des zugeordneten -Felds.

fieldId
path True
  • string

ID des Felds.

api-version
query True
  • string

Die angeforderte API-Version.

Anforderungsheader

Name Required Type Description
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 versucht haben, nicht authentifizierte Aufrufe durchzuführen.

Antworten

Name Type Description
200 OK

Erfolg

Other Status Codes

Fehler

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 versucht haben, nicht authentifizierte Aufrufe durchzuführen.

Type: apiKey
In: header

Beispiele

Fields_Get

Sample Request

GET /farmers/FARMER123/fields/FIELD123?api-version=2021-03-31-preview

Sample Response

{
  "id": "FIELD123",
  "farmerId": "FARMER123",
  "farmId": "FARM123",
  "primaryBoundaryId": "BOUNDARY123",
  "boundaryIds": [
    "BOUNDARY123",
    "BOUNDARY456"
  ],
  "name": "John Smith's Field",
  "status": "Active",
  "description": "Some description",
  "properties": {
    "Irrigated": "Yes",
    "RetailerId": "Retailer123"
  },
  "createdDateTime": "2021-04-21T06:49:30Z",
  "modifiedDateTime": "2021-04-21T06:49:30Z",
  "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e"
}

Definitionen

Error

Ein Fehler von Azure FarmBeats Dienst.

ErrorResponse

Eine Fehlerantwort des Azure AgPlatform-Diensts. ErrorResponse-Referenzdokument..

Field

Schema einer Feldressource.

InnerError

Innerer Fehler, der die Liste der Fehler enthält. InnerError-Referenzdokument.

Error

Ein Fehler von Azure FarmBeats Dienst.

Name Type Description
code
  • string

Serverdefinierte Gruppe von Fehlercodes.

details

Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.

innererror

Innerer Fehler, der die Liste der Fehler enthält. InnerError-Referenzdokument.

message
  • string

Lesbare Darstellung des Fehlers.

target
  • string

Ziel des Fehlers.

ErrorResponse

Eine Fehlerantwort des Azure AgPlatform-Diensts. ErrorResponse-Referenzdokument..

Name Type Description
error

Ein Fehler von Azure FarmBeats Dienst.

traceId
  • string

Eindeutige Ablaufverfolgungs-ID.

Field

Schema einer Feldressource.

Name Type Description
boundaryIds
  • string[]

Liste der IDs von Grenzen, die dem Feld zugeordnet sind.

createdDateTime
  • string

UTC-Datum/Uhrzeit der Erstellung der Ressource (Format: jjjj-MM-ttTHH:mm:ssZ).

description
  • string

Kurze Beschreibung des Felds.

eTag
  • string

Der ETag-Wert kann verwendet werden, um optimistische Parallelität zu implementieren.

farmId
  • string

ID des zugeordneten landwirtschaftlichen Betriebs.

farmerId
  • string

ID des zugeordneten -Felds.

id
  • string

Eindeutige ID des Felds.Diese ID ist für einen bestimmten Namen eindeutig.

modifiedDateTime
  • string

UTC-Datum/Uhrzeit der letzten Änderung der Ressource (Format: jjjj-MM-ttTHH:mm:ssZ).

name
  • string

Der Name des Felds.

primaryBoundaryId
  • string

Id der primären Grenze, die dem Feld zugeordnet ist. Zu jedem Zeitpunkt kann ein Feld maximal eine primäre Grenze enthalten.

properties
  • object

Eine Auflistung von Schlüsselwertpaaren, die der Ressource zugeordnet sind.Ein Schlüssel ist eine Zeichenfolge, und ein Wert kann ein numerischer Wert oder eine Zeichenfolge sein.Einer Ressource können maximal 25 Schlüsselwertpaare zugeordnet werden.

status
  • string

Der Benutzer hat den Status der Ressource bestimmt.

InnerError

Innerer Fehler, der die Liste der Fehler enthält. InnerError-Referenzdokument.

Name Type Description
code
  • string

Spezifischer Fehlercode, der vom enthaltenden Fehler bereitgestellt wurde.

innererror

Innerer Fehler, der die Liste der Fehler enthält. InnerError-Referenzdokument.