Freigeben über


Boundaries - Search

Suchen Sie nach Grenzen zwischen allen Parteien nach Feldern und sich überschneidende Geometrie.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
api-version
query True

string

Die angeforderte API-Version

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.

Anforderungstext

Name Typ Beschreibung
ids

string[]

Ids der Ressource.

intersectsWithGeometry GeoJsonObject:

GeoJSON (Weitere Informationen: https://geojson.org/). Hinweis: Koordinaten werden im Format [Längengrad, Breitengrad] erwartet.

maxArea

number

Maximale Anbaufläche der Grenze (inklusive).

maxCreatedDateTime

string

Maximales Erstellungsdatum der Ressource (inklusive).

maxLastModifiedDateTime

string

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

maxPageSize

integer

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

minArea

number

Mindestfläche der Grenze (inklusive).

minCreatedDateTime

string

Mindesterstellungsdatum der Ressource (inklusive).

minLastModifiedDateTime

string

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

names

string[]

Namen der Ressource.

parentIds

string[]

Übergeordnete ID der Ressource.

parentType

BoundaryParentType

Typ des übergeordneten Elements, zu dem er gehört.

propertyFilters

string[]

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

skipToken

string

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

statuses

string[]

Status der Ressource.

type

string

Geben Sie ein, zu dem sie gehört.

Antworten

Name Typ Beschreibung
200 OK

BoundaryMetadataListResponse

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 Aufrufe ausprobiert haben.

Typ: apiKey
In: header

Beispiele

Beispielanforderung

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
        ]
      ]
    ]
  }
}

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
BoundaryMetadata

Schema der Metadaten der Begrenzungsressourcen.

BoundaryMetadataListResponse

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

BoundaryParentType

Typ des übergeordneten Elements, zu dem er gehört. d.h. Field, SeasonalField, Zone, Prescription, PlantTissueAnalysis, ApplicationData, HarvestData, TillageData, PlantingData.

Error

Ein Fehler des Azure AgPlatform-Diensts.

ErrorResponse

Eine Fehlerantwort des Azure AgPlatform-Diensts. Weitere Informationen finden Sie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses unter ErrorResponse-Referenzdokument.

GeoJsonObjectType

GeoJSON-Objekttyp.

InnerError

Innerer Fehler, der eine Fehlerliste enthält. Weitere Informationen finden Sie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object unter InnerError-Referenzdokument.

Measure

Schema zum Speichern von Messwert und Einheit.

MultiPolygon

MultiPolygon-Geometrie.

Point

Punktgeometrie.

Polygon

Polygongeometrie.

SearchBoundaryQuery

SearchAllBoundaries- und SearchBoundaries-Parameter.

BoundaryMetadata

Schema der Metadaten der Begrenzungsressourcen.

Name Typ Beschreibung
area

Measure

Schema zum Speichern von Messwert und Einheit.

createdBy

string

Erstellt von Benutzer-/Mandanten-ID.

createdDateTime

string

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

description

string

Textbeschreibung der Ressource.

eTag

string

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

id

string

Eindeutige Ressourcen-ID.

modifiedBy

string

Geändert durch Benutzer-/Mandanten-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.

parentId

string

Id des übergeordneten Elements, zu dem es gehört.

parentType

BoundaryParentType

Typ des übergeordneten Elements, zu dem er gehört.

partyId

string

Partei-ID.

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.

source

string

Quelle der Ressource.

status

string

Status der Ressource.

type

string

Geben Sie ein, zu dem sie gehört.

BoundaryMetadataListResponse

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
nextLink

string

Fortsetzungslink (absoluter URI) auf die nächste Seite mit Ergebnissen in der Liste

skipToken

string

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

value

BoundaryMetadata[]

Liste der angeforderten Objekte.

BoundaryParentType

Typ des übergeordneten Elements, zu dem er gehört. d.h. Field, SeasonalField, Zone, Prescription, PlantTissueAnalysis, ApplicationData, HarvestData, TillageData, PlantingData.

Name Typ Beschreibung
ApplicationData

string

Field

string

HarvestData

string

PlantTissueAnalysis

string

PlantingData

string

Prescription

string

SeasonalField

string

TillageData

string

Zone

string

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. Weitere Informationen finden Sie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object unter InnerError-Referenzdokument.

message

string

Lesbare Darstellung des Fehlers.

target

string

Ziel des Fehlers.

ErrorResponse

Eine Fehlerantwort des Azure AgPlatform-Diensts. Weitere Informationen finden Sie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses unter ErrorResponse-Referenzdokument.

Name Typ Beschreibung
error

Error

Ein Fehler des Azure AgPlatform-Diensts.

traceId

string

Eindeutige Ablaufverfolgungs-ID.

GeoJsonObjectType

GeoJSON-Objekttyp.

Name Typ Beschreibung
MultiPolygon

string

Point

string

Polygon

string

InnerError

Innerer Fehler, der eine Fehlerliste enthält. Weitere Informationen finden Sie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object unter InnerError-Referenzdokument.

Name Typ Beschreibung
code

string

Spezifischer Fehlercode als vom enthaltenden Fehler bereitgestellt wurde.

innererror

InnerError

Innerer Fehler, der eine Fehlerliste enthält. Weitere Informationen finden Sie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object unter InnerError-Referenzdokument.

Measure

Schema zum Speichern von Messwert und Einheit.

Name Typ Beschreibung
unit

string

Dateneinheit.

value

number

Datenwert.

MultiPolygon

MultiPolygon-Geometrie.

Name Typ Beschreibung
coordinates

number[]

Ruft Koordinaten des GeoJSON-Objekts ab oder legt diese fest. Es muss sich um ein Array von Polygonen handeln, wobei jedes Polygon eine Liste von linearen Ringen enthält. Bei Polygonen mit mehr als einem dieser Ringe MUSS der erste der äußere Ring sein, und alle anderen MÜSSEN Innenringe sein.

type string:

MultiPolygon

GeoJSON-Objekttyp.

Point

Punktgeometrie.

Name Typ Beschreibung
coordinates

number[]

Ruft die Koordinate dieses Punkts ab oder legt sie fest. Es muss ein Array von 2 oder 3 Elementen für ein 2D- oder 3D-System sein.

type string:

Point

GeoJSON-Objekttyp.

Polygon

Polygongeometrie.

Name Typ Beschreibung
coordinates

number[]

Ruft den Typ des GeoJSON-Objekts ab oder legt diese fest. Es muss sich um ein Array linearer Ringkoordinatenarrays handelt. Bei Polygonen mit mehr als einem dieser Ringe MUSS der erste der äußere Ring sein, und alle anderen MÜSSEN Innenringe sein.

type string:

Polygon

GeoJSON-Objekttyp.

SearchBoundaryQuery

SearchAllBoundaries- und SearchBoundaries-Parameter.

Name Typ Standardwert Beschreibung
ids

string[]

Ids der Ressource.

intersectsWithGeometry GeoJsonObject:

GeoJSON (Weitere Informationen: https://geojson.org/). Hinweis: Koordinaten werden im Format [Längengrad, Breitengrad] erwartet.

maxArea

number

Maximale Anbaufläche der Grenze (inklusive).

maxCreatedDateTime

string

Maximales Erstellungsdatum der Ressource (inklusive).

maxLastModifiedDateTime

string

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

maxPageSize

integer

50

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

minArea

number

Mindestfläche der Grenze (inklusive).

minCreatedDateTime

string

Mindesterstellungsdatum der Ressource (inklusive).

minLastModifiedDateTime

string

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

names

string[]

Namen der Ressource.

parentIds

string[]

Übergeordnete ID der Ressource.

parentType

BoundaryParentType

Typ des übergeordneten Elements, zu dem er gehört.

propertyFilters

string[]

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

skipToken

string

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

statuses

string[]

Status der Ressource.

type

string

Geben Sie ein, zu dem sie gehört.