Freigeben über


Management Zones - List By Farmer Id

Gibt eine paginierte Liste der Verwaltungszonenressourcen unter einem bestimmten Landwirt zurück.

GET /farmers/{farmerId}/management-zones?api-version=2021-07-31-preview
GET /farmers/{farmerId}/management-zones?types={types}&cropIds={cropIds}&seasonIds={seasonIds}&fieldIds={fieldIds}&sources={sources}&ids={ids}&names={names}&propertyFilters={propertyFilters}&statuses={statuses}&minCreatedDateTime={minCreatedDateTime}&maxCreatedDateTime={maxCreatedDateTime}&minLastModifiedDateTime={minLastModifiedDateTime}&maxLastModifiedDateTime={maxLastModifiedDateTime}&$maxPageSize={$maxPageSize}&$skipToken={$skipToken}&api-version=2021-07-31-preview

URI-Parameter

Name In Erforderlich Typ Beschreibung
farmerId
path True

string

Id des zugeordneten Landwirts.

api-version
query True

string

Die angeforderte API-Version

$maxPageSize
query

integer

int32

Maximale Anzahl der benötigten Elemente (inklusive). Minimum = 10, Maximum = 1000, Standardwert = 50.

$skipToken
query

string

Überspringen Sie das Token, um den nächsten Satz von Ergebnissen abzurufen.

cropIds
query

string[]

CropIds der ManagementZone.

fieldIds
query

string[]

FieldIds der ManagementZone.

ids
query

string[]

Ids der Ressource.

maxCreatedDateTime
query

string

date-time

Maximales Erstellungsdatum der Ressource (inklusive).

maxLastModifiedDateTime
query

string

date-time

Maximales Datum der letzten Änderung der Ressource (einschließlich).

minCreatedDateTime
query

string

date-time

Mindesterstellungsdatum der Ressource (inklusive).

minLastModifiedDateTime
query

string

date-time

Mindestdatum der letzten Änderung der Ressource (einschließlich).

names
query

string[]

Namen der Ressource.

propertyFilters
query

string[]

Filtert nach Schlüssel-Wert-Paaren innerhalb des Properties-Objekts. Beispiel: "{testKey} eq {testValue}".

seasonIds
query

string[]

SeasonIds der ManagementZone.

sources
query

string[]

Quellen der ManagementZone.

statuses
query

string[]

Status der Ressource.

types
query

string[]

Typen der ManagementZone.

Anforderungsheader

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.

Antworten

Name Typ Beschreibung
200 OK

ManagementZoneListResponse

Erfolg

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

ManagementZones_ListByFarmerId

Beispielanforderung

GET /farmers/FARMER123/management-zones?api-version=2021-07-31-preview

Beispiel für eine Antwort

{
  "value": [
    {
      "farmerId": "FARMER123",
      "id": "ManagementZone123",
      "type": "Nutrient rich",
      "seasonId": "Season123",
      "cropId": "Crop123",
      "fieldId": "Field123",
      "source": "Agronomist",
      "name": "John Smith's ManagementZone",
      "status": "Active",
      "description": "Some description",
      "properties": {
        "Irrigated": "Yes"
      },
      "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}}/management-zones?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

Name Beschreibung
Error

Ein Fehler des Azure AgPlatform-Diensts.

ErrorResponse

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

InnerError

Innerer Fehler, der eine Fehlerliste enthält. InnerError-Referenzdokument.

ManagementZone

Api Model for ManagementZone-Objekt.

ManagementZoneListResponse

Die ausgelagerte Antwort enthält eine Liste der angeforderten Objekte und einen URL-Link, um den nächsten Satz von Ergebnissen zu erhalten.

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. InnerError-Referenzdokument.

message

string

Lesbare Darstellung des Fehlers.

target

string

Ziel des Fehlers.

ErrorResponse

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

Name Typ Beschreibung
error

Error

Ein Fehler des Azure AgPlatform-Diensts.

traceId

string

Eindeutige Ablaufverfolgungs-ID.

InnerError

Innerer Fehler, der eine Fehlerliste enthält. InnerError-Referenzdokument.

Name Typ Beschreibung
code

string

Spezifischer Fehlercode als vom enthaltenden Fehler bereitgestellt wurde.

innererror

InnerError

Innerer Fehler, der eine Fehlerliste enthält. InnerError-Referenzdokument.

ManagementZone

Api Model for ManagementZone-Objekt.

Name Typ Beschreibung
createdDateTime

string

Datum und Uhrzeit der Erstellung der Ressource, Beispielformat: jjjj-MM-ttTHH:mm:ssZ.

cropId

string

Zuschneiden-ID, die der ManagementZone zugeordnet ist.

description

string

Textbeschreibung der Ressource.

eTag

string

Der ETag-Wert, um eine optimistische Parallelität zu implementieren.

farmerId

string

Farmer-ID, die der ManagementZone zugeordnet ist.

fieldId

string

Feld-ID, die der ManagementZone zugeordnet ist.

id

string

Eindeutige Ressourcen-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.

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.

seasonId

string

Saison-ID, die der ManagementZone zugeordnet ist.

source

string

Quelle der Ressource.

status

string

Status der Ressource.

type

string

Typ der ManagementZone.

ManagementZoneListResponse

Die ausgelagerte Antwort enthält eine Liste der angeforderten Objekte und einen URL-Link, um den nächsten Satz von Ergebnissen zu erhalten.

Name Typ Beschreibung
$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

value

ManagementZone[]

Liste der angeforderten Objekte.