Fields - List

Abrufen einer paginierten Liste von Feldressourcen für alle Mitarbeiter für ein bestimmtes Suchkriterium.

Hinweis:
  1. Diese API führt eine serielle Suche der Datenbank nach den angegebenen Suchkriterien durch. Wenn die Id des Unternehmens verfügbar ist, wird dringend empfohlen, die API "List byZusammenstellungs-ID" zu verwenden, da sie leistungsvoll ist.
  2. Benutzer erhalten eine paginierte Antwort mit jeder Seite, die einen Link zur nächsten Seite enthält. Einige Seiten enthalten möglicherweise keine Elemente (0 Ergebnisse). Es wird erwartet, dass Benutzer alle Seiten mithilfe von "nextLink" iterieren. Die Suche endet, wenn "nextLink" NULL ist.
GET /fields?api-version=2021-03-31-preview
GET /fields?farmIds={farmIds}&ids={ids}&names={names}&propertyFilters={propertyFilters}&statuses={statuses}&minCreatedDateTime={minCreatedDateTime}&maxCreatedDateTime={maxCreatedDateTime}&minLastModifiedDateTime={minLastModifiedDateTime}&maxLastModifiedDateTime={maxLastModifiedDateTime}&$maxPageSize={$maxPageSize}&$skipToken={$skipToken}&api-version=2021-03-31-preview

URI-Parameter

Name In Required Type Description
api-version
query True
  • string

Die angeforderte API-Version.

$maxPageSize
query
  • integer
int32

Maximale Anzahl von Elementen, die auf einer einzelnen Seite zurückgegeben werden sollen.

$skipToken
query
  • string

Überspringt das Token zum Abrufen des nächsten Resultsets.

farmIds
query
  • array

Felder, die der angegebenen Liste von landwirtschaftlichen Betrieben zugeordnet sind, werden zurückgegeben.

ids
query
  • array

Liste der IDs von Feldern, die zurückgegeben werden sollen.

maxCreatedDateTime
query
  • string
date-time

Ressourcen, die um oder vor der angegebenen UTC-Datums-/Uhrzeit erstellt wurden, werden zurückgegeben (Format: jjjj-MM-ttTHH:mm:ssZ).

maxLastModifiedDateTime
query
  • string
date-time

Ressourcen, die zuletzt um oder vor der angegebenen UTC-Datums-/Uhrzeit geändert wurden, werden zurückgegeben (Format: yyyy-MM-ddTHH:mm:ssZ).

minCreatedDateTime
query
  • string
date-time

Ressourcen, die um oder nach der angegebenen UTC-Datums-/Uhrzeit erstellt wurden, werden zurückgegeben (Format: jjjj-MM-ttTHH:mm:ssZ).

minLastModifiedDateTime
query
  • string
date-time

Ressourcen, die am oder nach der angegebenen UTC-Datums-/Uhrzeit geändert wurden, werden zurückgegeben (Format: jjjj-MM-ttTHH:mm:ssZ).

names
query
  • array

Liste der Namen der zurückzugebenden Felder.

propertyFilters
query
  • array

Filtert nach Schlüssel-Wert-Paaren innerhalb von "Eigenschaften". Beispiel:"{testKey} eq {testValue}".

statuses
query
  • array

Felder mit nur den angegebenen Status werden zurückgegeben.

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_List

Sample Request

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

Sample Response

{
  "value": [
    {
      "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"
    }
  ],
  "$skipToken": "string",
  "nextLink": "https://{{resourceName}}.farmbeats.azure.net/farmers/{{farmerId}}/seasonalFields/{{seasonalFieldId}}?api-version={{apiVersion}}&$skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d"
}

Definitionen

Error

Ein Fehler von Azure FarmBeats Dienst.

ErrorResponse

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

Field

Schema einer Feldressource.

FieldListResponse

Die seitenseitige Antwort enthält eine Liste der angeforderten Objekte und einen URL-Link, um die nächsten Ergebnisse abzurufen.

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.

FieldListResponse

Die seitenseitige Antwort enthält eine Liste der angeforderten Objekte und einen URL-Link, um die nächsten Ergebnisse abzurufen.

Name Type Description
$skipToken
  • string

Token, das beim Abrufen der nächsten Seite verwendet wird. Wenn NULL, gibt es keine zusätzlichen Seiten.

nextLink
  • string

Fortsetzungslink (absoluter URI) auf die nächste Seite mit Ergebnissen in der Liste Wenn NULL, gibt es keine zusätzlichen Seiten.

value

Liste der angeforderten Objekte.

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.