Boundaries - Search

Service:: Azure Data Manager for Agriculture

API-versie:: 2023-06-01-preview

Zoek naar grenzen voor alle partijen op velden en snijgeometrie.

POST /boundaries?api-version=2023-06-01-preview

URI-parameters

Name	In	Vereist	Type	Description
api-version	query	True	string	De aangevraagde API-versie

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.

Aanvraagbody

Name	Type	Description
ids	string[]	Id's van de resource.
intersectsWithGeometry	GeoJsonObject: MultiPolygon Point Polygon	GeoJSON (voor meer informatie: https://geojson.org/). Opmerking: Coördinaten worden verwacht in de indeling [Lengtegraad, Breedtegraad].
maxArea	number (double)	Maximale acreage van de grens (inclusief).
maxCreatedDateTime	string (date-time)	Maximale aanmaakdatum van resource (inclusief).
maxLastModifiedDateTime	string (date-time)	Maximale datum van laatste wijziging van resource (inclusief).
maxPageSize	integer (int32) minimum: 10 maximum: 1000	Maximum aantal benodigde items (inclusief). Minimum = 10, Maximum = 1000, Standaardwaarde = 50.
minArea	number (double)	Minimale acreage van de grens (inclusief).
minCreatedDateTime	string (date-time)	Minimale aanmaakdatum van resource (inclusief).
minLastModifiedDateTime	string (date-time)	Minimale datum van laatste wijziging van resource (inclusief).
names	string[]	Namen van de resource.
parentIds	string[]	Bovenliggende id's van de resource.
parentType	BoundaryParentType	Het type van het bovenliggende item waartoe het behoort.
propertyFilters	string[]	Filters op sleutel-waardeparen in het object Eigenschappen. bijvoorbeeld {testKey} eq {testValue}.
skipToken	string	Sla het token over voor het ophalen van de volgende set resultaten.
statuses	string[]	Statussen van de resource.
type	string	Typ het waartoe het behoort.

Antwoorden

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

Name

Type

Description

200 OK

BoundaryMetadataListResponse

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

Boundaries_Search

Voorbeeldaanvraag

HTTP

POST /boundaries?api-version=2023-06-01-preview

{
  "ids": [
    "BOUNDARY123"
  ],
  "names": [
    "John Smith's Boundary"
  ],
  "propertyFilters": [
    "RetailerId"
  ],
  "statuses": [
    "Active"
  ],
  "minCreatedDateTime": "2021-04-22T12:53:39Z",
  "maxCreatedDateTime": "2021-04-22T12:53:39Z",
  "minLastModifiedDateTime": "2021-04-22T12:53:39Z",
  "maxLastModifiedDateTime": "2021-04-22T12:53:39Z",
  "maxPageSize": 50,
  "skipToken": "string",
  "parentType": "Field",
  "parentIds": [
    "FIELD123"
  ],
  "intersectsWithGeometry": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          10.98958969116211,
          45.284911882713146
        ],
        [
          11.004695892333984,
          45.284911882713146
        ],
        [
          11.004695892333984,
          45.29360722000945
        ],
        [
          10.98958969116211,
          45.29360722000945
        ],
        [
          10.98958969116211,
          45.284911882713146
        ]
      ]
    ]
  }
}

Voorbeeldrespons

Statuscode:: 200

{
  "value": [
    {
      "parentId": "FIELD123",
      "parentType": "Field",
      "area": {
        "unit": "Acre",
        "value": 60.405
      },
      "name": "John Smith's Boundary",
      "description": "Some description"
    }
  ],
  "skipToken": "string",
  "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/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"
}

Definities

Name	Description
BoundaryMetadata	Schema van metagegevens van grensresources.
BoundaryMetadataListResponse	Gepaginad antwoord bevat een lijst met aangevraagde objecten en een URL-koppeling om de volgende set resultaten op te halen.
BoundaryParentType	Het type van het bovenliggende item waartoe het behoort. Veld, SeasonalField, Zone, Recept, PlantTissueAnalysis, ApplicationData, HarvestData, TillageData, PlantingData.
Error	Een fout van de Azure AgPlatform-service.
ErrorResponse	Een foutreactie van de Azure AgPlatform-service. Zie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses voor het referentiedocument ErrorResponse.
GeoJsonObjectType	GeoJSON-objecttype.
InnerError	Interne fout met een lijst met fouten. Zie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object voor innerError-referentiedocument.
Measure	Schema voor het opslaan van meting en eenheid.
MultiPolygon	MultiPolygon geometrie.
Point	Puntgeometrie.
Polygon	Polygoongeometrie.
SearchBoundaryQuery	Parameters SearchAllBoundaries en SearchBoundaries.

BoundaryMetadata

Object

Schema van metagegevens van grensresources.

Name	Type	Description
area	Measure	Schema voor het opslaan van meting en eenheid.
createdBy	string	Gemaakt door gebruiker/tenant-id.
createdDateTime	string (date-time)	Datum en tijd waarop de resource is gemaakt, voorbeeldindeling: jjjj-MM-ddTHH:mm:ssZ.
description	string minLength: 0 maxLength: 500	Tekstbeschrijving van de resource.
eTag	string	De ETag-waarde voor het implementeren van optimistische gelijktijdigheid.
id	string	Unieke resource-id.
modifiedBy	string	Gewijzigd door de gebruikers-/tenant-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.
parentId	string	Id van het bovenliggende item waartoe het behoort.
parentType	BoundaryParentType	Het type van het bovenliggende item waartoe het behoort.
partyId	string	Partij-id.
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.
source	string minLength: 2 maxLength: 100	Bron van de resource.
status	string minLength: 0 maxLength: 100	Status van de resource.
type	string	Typ het waartoe het behoort.

BoundaryMetadataListResponse

Object

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

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

BoundaryParentType

Inventarisatie

Het type van het bovenliggende item waartoe het behoort. Veld, SeasonalField, Zone, Recept, PlantTissueAnalysis, ApplicationData, HarvestData, TillageData, PlantingData.

Waarde	Description
Field
SeasonalField
Zone
Prescription
PlantTissueAnalysis
ApplicationData
PlantingData
TillageData
HarvestData

Error

Object

Een fout van de Azure AgPlatform-service.

Name	Type	Description
code	string minLength: 1	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 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object voor innerError-referentiedocument.
message	string minLength: 1	Leesbare weergave van de fout.
target	string	Doel van de fout.

ErrorResponse

Object

Een foutreactie van de Azure AgPlatform-service. Zie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses voor het referentiedocument ErrorResponse.

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

GeoJsonObjectType

Inventarisatie

GeoJSON-objecttype.

Waarde	Description
Point
Polygon
MultiPolygon

InnerError

Object

Interne fout met een lijst met fouten. Zie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object voor innerError-referentiedocument.

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

Measure

Object

Schema voor het opslaan van meting en eenheid.

Name	Type	Description
unit	string minLength: 1 maxLength: 50	Gegevenseenheid.
value	number (double)	Gegevenswaarde.

MultiPolygon

Object

MultiPolygon geometrie.

Name	Type	Description
coordinates	number[] (double)	Hiermee worden coördinaten van GeoJSON-object opgehaald of ingesteld. Het moet een matrix van veelhoeken zijn, elke veelhoek bevat een lijst met lineaire ringen. Voor veelhoeken met meer dan een van deze ringen moet de eerste buitenring zijn, en alle andere moeten binnenringen zijn.
type	string: MultiPolygon	GeoJSON-objecttype.

Point

Object

Puntgeometrie.

Name	Type	Description
coordinates	number[] (double)	Hiermee haalt u de coördinaat van dit punt op of stelt u deze in. Het moet een matrix van 2 of 3 elementen zijn voor een 2D- of 3D-systeem.
type	string: Point	GeoJSON-objecttype.

Polygon

Object

Polygoongeometrie.

Name	Type	Description
coordinates	number[] (double)	Hiermee wordt het type GeoJSON-object opgehaald of ingesteld. Dit moet een matrix van lineaire-ringcoördinaatmatrices zijn. Voor veelhoeken met meer dan een van deze ringen moet de eerste buitenring zijn, en alle andere moeten binnenringen zijn.
type	string: Polygon	GeoJSON-objecttype.

SearchBoundaryQuery

Object

Parameters SearchAllBoundaries en SearchBoundaries.

Name	Type	Default value	Description
ids	string[]		Id's van de resource.
intersectsWithGeometry	GeoJsonObject: MultiPolygon Point Polygon		GeoJSON (voor meer informatie: https://geojson.org/). Opmerking: Coördinaten worden verwacht in de indeling [Lengtegraad, Breedtegraad].
maxArea	number (double)		Maximale acreage van de grens (inclusief).
maxCreatedDateTime	string (date-time)		Maximale aanmaakdatum van resource (inclusief).
maxLastModifiedDateTime	string (date-time)		Maximale datum van laatste wijziging van resource (inclusief).
maxPageSize	integer (int32) minimum: 10 maximum: 1000	50	Maximum aantal benodigde items (inclusief). Minimum = 10, Maximum = 1000, Standaardwaarde = 50.
minArea	number (double)		Minimale acreage van de grens (inclusief).
minCreatedDateTime	string (date-time)		Minimale aanmaakdatum van resource (inclusief).
minLastModifiedDateTime	string (date-time)		Minimale datum van laatste wijziging van resource (inclusief).
names	string[]		Namen van de resource.
parentIds	string[]		Bovenliggende id's van de resource.
parentType	BoundaryParentType		Het type van het bovenliggende item waartoe het behoort.
propertyFilters	string[]		Filters op sleutel-waardeparen in het object Eigenschappen. bijvoorbeeld {testKey} eq {testValue}.
skipToken	string		Sla het token over voor het ophalen van de volgende set resultaten.
statuses	string[]		Statussen van de resource.
type	string		Typ het waartoe het behoort.

Delen via

Boundaries - Search

URI-parameters

Aanvraagkoptekst

Aanvraagbody

Antwoorden

Beveiliging

Authorization

Voorbeelden

Boundaries_Search

Voorbeeldaanvraag

Voorbeeldrespons

Definities

BoundaryMetadata

BoundaryMetadataListResponse

BoundaryParentType

Error

ErrorResponse

GeoJsonObjectType

InnerError

Measure

MultiPolygon

Point

Polygon

SearchBoundaryQuery