Zones - List

Dienst:

Azure Data Manager for Agriculture

API-Version:

2023-06-01-preview

Gibt eine paginierte Liste von Zonenressourcen für alle Parteien zurück.

GET /zones?api-version=2023-06-01-preview

Mit optionalen Parametern:

GET /zones?types={types}&managementZoneIds={managementZoneIds}&sources={sources}&ids={ids}&names={names}&propertyFilters={propertyFilters}&statuses={statuses}&minCreatedDateTime={minCreatedDateTime}&maxCreatedDateTime={maxCreatedDateTime}&minLastModifiedDateTime={minLastModifiedDateTime}&maxLastModifiedDateTime={maxLastModifiedDateTime}&maxPageSize={maxPageSize}&skipToken={skipToken}&api-version=2023-06-01-preview

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
api-version	query	True	string	Die angeforderte API-Version
ids	query		string[]	IDs der Ressource.
managementZoneIds	query		string[]	ManagementZoneIds der Zonen.
maxCreatedDateTime	query		string (date-time)	Maximale Erstellungsdatum der Ressource (einschließlich).
maxLastModifiedDateTime	query		string (date-time)	Maximales Datum der letzten Änderung der Ressource (einschließlich).
maxPageSize	query		integer (int32) minimum: 10 maximum: 1000	Maximale Anzahl der benötigten Elemente (einschließlich). Minimum = 10, Maximum = 1000, Standardwert = 50.
minCreatedDateTime	query		string (date-time)	Mindesterstellungsdatum der Ressource (einschließlich).
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üsselwertpaaren innerhalb des Properties-Objekts. Zb. "{testKey} eq {testValue}".
skipToken	query		string	Überspringen Sie das Token, um die nächste Gruppe von Ergebnissen zu erhalten.
sources	query		string[]	Quellen der Zonen.
statuses	query		string[]	Status der Ressource.
types	query		string[]	Typen der Zonen.

Anforderungsheader

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

Antworten

Name	Typ	Beschreibung
200 OK	ZoneListResponse	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 ihren Browsercache möglicherweise löschen müssen, wenn Sie zuvor nicht authentifizierte Anrufe ausprobiert haben.

Typ: apiKey
In: header

Beispiele

Zones_List

Beispielanforderung

HTTP

GET /zones?api-version=2023-06-01-preview

Beispiel für eine Antwort

Statuscode:

200

{
  "value": [
    {
      "partyId": "PARTY123",
      "id": "Zone123",
      "managementZoneId": "ManagementZone123",
      "type": "Nutrient rich",
      "status": "Active",
      "name": "John Smith's Zone",
      "description": "Some description",
      "source": "source",
      "properties": {
        "Irrigated": "Yes"
      },
      "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"
    }
  ],
  "skipToken": "string",
  "nextLink": "https://{{resourceName}}.farmbeats.azure.net/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	Fehler des Azure AgPlatform-Diensts.
ErrorResponse	Eine Fehlerantwort des Azure AgPlatform-Diensts. Siehe https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses für ErrorResponse-Referenzdokument.
InnerError	Interner Fehler, der eine Liste von Fehlern enthält. Siehe https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object für das InnerError-Referenzdokument.
Zone	API-Modell für Zone-Objekt.
ZoneListResponse	Die seitenseitige Antwort enthält eine Liste der angeforderten Objekte und einen URL-Link, um den nächsten Satz von Ergebnissen abzurufen.

Error

Objekt

Fehler des Azure AgPlatform-Diensts.

Name	Typ	Beschreibung
code	string minLength: 1	Serverdefinierter Satz von Fehlercodes.
details	Error[]	Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	InnerError	Interner Fehler, der eine Liste von Fehlern enthält. Siehe https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object für das InnerError-Referenzdokument.
message	string minLength: 1	Lesbare Darstellung des Fehlers.
target	string	Ziel des Fehlers.

ErrorResponse

Objekt

Eine Fehlerantwort des Azure AgPlatform-Diensts. Siehe https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses für ErrorResponse-Referenzdokument.

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

InnerError

Objekt

Interner Fehler, der eine Liste von Fehlern enthält. Siehe https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object für das InnerError-Referenzdokument.

Name	Typ	Beschreibung
code	string	Spezifischer Fehlercode, der vom enthaltenden Fehler bereitgestellt wurde.
innererror	InnerError	Interner Fehler, der eine Liste von Fehlern enthält. Siehe https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object für das InnerError-Referenzdokument.

Zone

Objekt

API-Modell für Zone-Objekt.

Name	Typ	Beschreibung
createdBy	string	Erstellt von der Benutzer-/Mandanten-ID.
createdDateTime	string (date-time)	Datum-Uhrzeit der Erstellung der Ressource, Beispielformat: yyyy-MM-ddTHH:mm:ssZ.
description	string minLength: 0 maxLength: 500	Textbeschreibung der Ressource.
eTag	string	Der ETag-Wert, der optimistische Parallelität implementiert.
id	string	Eindeutige Ressourcen-ID.
managementZoneId	string	Verwaltungszonen-ID, die der Zone zugeordnet ist.
modifiedBy	string	Geändert von Benutzer-/Mandanten-ID.
modifiedDateTime	string (date-time)	Datum-Uhrzeit der letzten Änderung der Ressource, Beispielformat: yyyy-MM-ddTHH:mm:ssZ.
name	string minLength: 0 maxLength: 100	Name zum Identifizieren der Ressource.
partyId	string	Der Zone zugeordnete Party-ID.
properties		Eine Sammlung von Schlüsselwertpaaren, die zur Ressource gehören. Jedes Paar darf nicht über einen Schlüssel größer als 50 Zeichen verfügen 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-, Numeral- und Datetime-Werte (yyyy-MM-ddTHH:mm:ssZ) unterstützt.
source	string minLength: 2 maxLength: 100	Quelle der Ressource.
status	string minLength: 0 maxLength: 100	Status der Ressource.
type	string minLength: 0 maxLength: 100	Typ der Zone.

ZoneListResponse

Objekt

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

Name	Typ	Beschreibung
nextLink	string	Fortsetzungslink (absoluter URI) zur nächsten Seite der Ergebnisse in der Liste.
skipToken	string	Token, das beim Abrufen der nächsten Seite verwendet wird. Wenn null ist, gibt es keine zusätzlichen Seiten.
value	Zone[]	Liste der angeforderten Objekte.