Management Zones - List By Farmer Id

Service:: Azure Data Manager for Agriculture

API-versie:: 2021-07-31-preview

Retourneert een gepagineerde lijst met beheerzone-resources onder een bepaalde boer.

GET /farmers/{farmerId}/management-zones?api-version=2021-07-31-preview

Met optionele parameters:

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-parameters

Name	In	Vereist	Type	Description
farmerId	path	True	string	Id van de gekoppelde boer.
api-version	query	True	string	De aangevraagde API-versie
$maxPageSize	query		integer (int32) minimum: 10 maximum: 1000	Maximum aantal benodigde items (inclusief). Minimum = 10, Maximum = 1000, Standaardwaarde = 50.
$skipToken	query		string	Sla het token over voor het ophalen van de volgende set resultaten.
cropIds	query		string[]	CropIds van de ManagementZone.
fieldIds	query		string[]	FieldIds van de ManagementZone.
ids	query		string[]	Id's van de resource.
maxCreatedDateTime	query		string (date-time)	Maximale aanmaakdatum van resource (inclusief).
maxLastModifiedDateTime	query		string (date-time)	Maximale datum van laatste wijziging van resource (inclusief).
minCreatedDateTime	query		string (date-time)	Minimale aanmaakdatum van resource (inclusief).
minLastModifiedDateTime	query		string (date-time)	Minimale datum van laatste wijziging van resource (inclusief).
names	query		string[]	Namen van de resource.
propertyFilters	query		string[]	Filters op sleutel-waardeparen in het object Eigenschappen. bijvoorbeeld "{testKey} eq {testValue}".
seasonIds	query		string[]	SeasonIds van de ManagementZone.
sources	query		string[]	Bronnen van de ManagementZone.
statuses	query		string[]	Statussen van de resource.
types	query		string[]	Typen van de ManagementZone.

Aanvraagkoptekst

Name	Vereist	Type	Description
Authorization	True	string	Geef een geldig Bearer-token op voor geautoriseerde API-aanroepen. Houd er rekening mee dat u uw browsercache mogelijk moet wissen als u eerder niet-geverifieerde aanroepen hebt geprobeerd.

Antwoorden

Name	Type	Description
200 OK	ManagementZoneListResponse	Geslaagd
Other Status Codes	ErrorResponse	Fout Kopteksten x-ms-error-code: string

Name

Type

Description

200 OK

ManagementZoneListResponse

Geslaagd

Other Status Codes

ErrorResponse

Fout

Kopteksten

x-ms-error-code: string

Beveiliging

Authorization

Geef een geldig Bearer-token op voor geautoriseerde API-aanroepen. Houd er rekening mee dat u uw browsercache mogelijk moet wissen als u eerder niet-geverifieerde aanroepen hebt geprobeerd.

Type: apiKey
In: header

Voorbeelden

ManagementZones_ListByFarmerId

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:: 200

{
  "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"
}

Definities

Name	Description
Error	Een fout van de Azure AgPlatform-service.
ErrorResponse	Een foutreactie van de Azure AgPlatform-service. <zie href="https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses">ErrorResponse referentiedocument.</zie>.
InnerError	Interne fout met een lijst met fouten. <zie href="https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object">InnerError referentiedocument</zie>.
ManagementZone	Api-model voor ManagementZone-object.
ManagementZoneListResponse	Gepaginad antwoord bevat een lijst met aangevraagde objecten en een URL-koppeling om de volgende set resultaten op te halen.

Error

Object

Een fout van de Azure AgPlatform-service.

Name	Type	Description
code	string	Door de server gedefinieerde set foutcodes.
details	Error[]	Matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.
innererror	InnerError	Interne fout met een lijst met fouten. <zie href="https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object">InnerError referentiedocument</zie>.
message	string	Leesbare weergave van de fout.
target	string	Doel van de fout.

ErrorResponse

Object

Een foutreactie van de Azure AgPlatform-service. <zie href="https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses">ErrorResponse referentiedocument.</zie>.

Name	Type	Description
error	Error	Een fout van de Azure AgPlatform-service.
traceId	string	Unieke tracerings-id.

InnerError

Object

Interne fout met een lijst met fouten. <zie href="https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object">InnerError referentiedocument</zie>.

Name	Type	Description
code	string	Specifieke foutcode dan is opgegeven door de bijbehorende fout.
innererror	InnerError	Interne fout met een lijst met fouten. <zie href="https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object">InnerError referentiedocument</zie>.

ManagementZone

Object

Api-model voor ManagementZone-object.

Name	Type	Description
createdDateTime	string (date-time)	Datum en tijd waarop de resource is gemaakt, voorbeeldindeling: jjjj-MM-ddTHH:mm:ssZ.
cropId	string	Bijsnijd-id die is gekoppeld aan de ManagementZone.
description	string minLength: 0 maxLength: 500	Tekstbeschrijving van de resource.
eTag	string	De ETag-waarde voor het implementeren van optimistische gelijktijdigheid.
farmerId	string	Boer-id gekoppeld aan de ManagementZone.
fieldId	string	Veld-id die is gekoppeld aan de ManagementZone.
id	string	Unieke resource-id.
modifiedDateTime	string (date-time)	Datum en tijd waarop de resource voor het laatst is gewijzigd, voorbeeldindeling: jjjj-MM-ddTHH:mm:ssZ.
name	string minLength: 0 maxLength: 100	Naam om de resource te identificeren.
properties		Een verzameling sleutel-waardeparen die deel uitmaken van de resource. Elk paar mag geen sleutel van meer dan 50 tekens hebben en mag geen waarde van meer dan 150 tekens hebben. Opmerking: er kunnen maximaal 25 sleutelwaardeparen worden opgegeven voor een resource en alleen tekenreeks-, numerieke en datum/tijd-waarden (jjjj-MM-ddTHH:mm:ssZ) worden ondersteund.
seasonId	string	Seizoen-id gekoppeld aan de ManagementZone.
source	string minLength: 2 maxLength: 100	Bron van de resource.
status	string minLength: 0 maxLength: 100	Status van de resource.
type	string minLength: 0 maxLength: 100	Type van de ManagementZone.

ManagementZoneListResponse

Object

Gepaginad antwoord bevat een lijst met aangevraagde objecten en een URL-koppeling om de volgende set resultaten op te halen.

Name	Type	Description
$skipToken	string	Token dat wordt gebruikt bij het ophalen van de volgende pagina. Als null is, zijn er geen extra pagina's.
nextLink	string	Vervolgkoppeling (absolute URI) naar de volgende pagina met resultaten in de lijst.
value	ManagementZone[]	Lijst met aangevraagde objecten.

Delen via

Management Zones - List By Farmer Id

URI-parameters

Aanvraagkoptekst

Antwoorden

Beveiliging

Authorization

Voorbeelden

ManagementZones_ListByFarmerId

Voorbeeldaanvraag

Voorbeeldrespons

Definities

Error

ErrorResponse

InnerError

ManagementZone

ManagementZoneListResponse