Boundaries - Search

Szolgáltatás:: Azure Data Manager for Agriculture

API-verzió:: 2023-06-01-preview

Az összes fél határainak keresése mezők és metsző geometria szerint.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
api-version	query	True	string	A kért API-verzió

Kérelem fejléce

Name	Kötelező	Típus	Description
Authorization	True	string	Adjon meg érvényes tulajdonosi jogkivonatot az engedélyezett API-hívásokhoz. Vegye figyelembe, hogy előfordulhat, hogy törölnie kell a böngésző gyorsítótárát, ha korábban nem hitelesített hívásokat próbált meg.

Kérelem törzse

Name	Típus	Description
ids	string[]	Az erőforrás azonosítói.
intersectsWithGeometry	GeoJsonObject: MultiPolygon Point Polygon	GeoJSON (További részletek: https://geojson.org/). Megjegyzés: A koordináták [Hosszúság, Szélesség] formátumban várhatók.
maxArea	number (double)	A határ maximális kiterjedése (a határt is beleértve).
maxCreatedDateTime	string (date-time)	Az erőforrás létrehozásának maximális dátuma (beleértve az erőforrást is).
maxLastModifiedDateTime	string (date-time)	Az erőforrás utolsó módosításának maximális dátuma (beleértve az erőforrást is).
maxPageSize	integer (int32) minimum: 10 maximum: 1000	A szükséges elemek maximális száma (beleértve a elemet is). Minimum = 10, Maximum = 1000, Alapértelmezett érték = 50.
minArea	number (double)	A határ minimális kiterjedése (a határt is beleértve).
minCreatedDateTime	string (date-time)	Az erőforrás minimális létrehozási dátuma (beleértve az erőforrást is).
minLastModifiedDateTime	string (date-time)	Az erőforrás utolsó módosításának minimális dátuma (beleértve az erőforrást is).
names	string[]	Az erőforrás nevei.
parentIds	string[]	Az erőforrás szülőazonosítói.
parentType	BoundaryParentType	Annak a szülőnek a típusa, amelyhez tartozik.
propertyFilters	string[]	A Tulajdonságok objektumon belüli kulcs-érték párokra vonatkozó szűrők. Például: "{testKey} eq {testValue}".
skipToken	string	A következő találatkészlet lekéréséhez hagyja ki a jogkivonatot.
statuses	string[]	Az erőforrás állapota.
type	string	Írja be, hogy a fájlhoz tartozik.

Válaszok

Name	Típus	Description
200 OK	BoundaryMetadataListResponse	Siker
Other Status Codes	ErrorResponse	Hiba Fejlécek x-ms-error-code: string

Name

Típus

Description

200 OK

BoundaryMetadataListResponse

Siker

Other Status Codes

ErrorResponse

Hiba

Fejlécek

x-ms-error-code: string

Biztonság

Authorization

Adjon meg érvényes tulajdonosi jogkivonatot az engedélyezett API-hívásokhoz. Vegye figyelembe, hogy előfordulhat, hogy törölnie kell a böngésző gyorsítótárát, ha korábban nem hitelesített hívásokat próbált meg.

Típus: apiKey
In: header

Példák

Boundaries_Search

Mintakérelem

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

Mintaválasz

Állapotkód:: 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"
}

Definíciók

Name	Description
BoundaryMetadata	A határerőforrás metaadatainak sémája.
BoundaryMetadataListResponse	A lapozott válasz a kért objektumok listáját és egy URL-hivatkozást tartalmaz a következő találatkészlet lekéréséhez.
BoundaryParentType	Annak a szülőnek a típusa, amelyhez tartozik. Például Mező, Szezonális mező, Zóna, Recept, PlantTissueAnalysis, ApplicationData, HarvestData, TillageData, PlantingData.
Error	Az Azure AgPlatform szolgáltatás hibája.
ErrorResponse	Hibaválasz az Azure AgPlatform szolgáltatástól. Az ErrorResponse referenciadokumentumának https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
GeoJsonObjectType	GeoJSON objektumtípus.
InnerError	A hibák listáját tartalmazó belső hiba. Lásd az InnerError-referenciadokumentum https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object.
Measure	A mérési adatok és egységek tárolására szolgáló séma.
MultiPolygon	Többpógonyos geometria.
Point	Pontgeometria.
Polygon	Sokszög geometria.
SearchBoundaryQuery	SearchAllBoundaries és SearchBoundaries paraméterek.

BoundaryMetadata

Objektum

A határerőforrás metaadatainak sémája.

Name	Típus	Description
area	Measure	A mérési adatok és egységek tárolására szolgáló séma.
createdBy	string	A felhasználó/bérlő azonosítója hozza létre.
createdDateTime	string (date-time)	Az erőforrás létrehozásának dátuma, mintaformátum: yyyy-MM-ddTHH:mm:ssZ.
description	string minLength: 0 maxLength: 500	Az erőforrás szöveges leírása.
eTag	string	Az ETag értéke az optimista egyidejűség megvalósításához.
id	string	Egyedi erőforrás-azonosító.
modifiedBy	string	Módosítva a felhasználó/bérlő azonosítója.
modifiedDateTime	string (date-time)	Az erőforrás utolsó módosításának dátuma, mintaformátum: yyyy-MM-ddTHH:mm:ssZ.
name	string minLength: 0 maxLength: 100	Az erőforrás azonosítására szolgáló név.
parentId	string	Annak a szülőnek az azonosítója, amelyhez tartozik.
parentType	BoundaryParentType	Annak a szülőnek a típusa, amelyhez tartozik.
partyId	string	Félazonosító.
properties		Az erőforráshoz tartozó kulcsértékpárok gyűjteménye. Minden párnak nem lehet 50 karakternél nagyobb kulcsa, és nem lehet 150 karakternél nagyobb érték. Megjegyzés: Egy erőforráshoz legfeljebb 25 kulcsértékpár adható meg, és csak a sztring, a szám és a datetime (yyyy-MM-ddTHH:mm:ssZ) értékek támogatottak.
source	string minLength: 2 maxLength: 100	Az erőforrás forrása.
status	string minLength: 0 maxLength: 100	Az erőforrás állapota.
type	string	Írja be, hogy a fájlhoz tartozik.

BoundaryMetadataListResponse

Objektum

A lapozott válasz a kért objektumok listáját és egy URL-hivatkozást tartalmaz a következő találatkészlet lekéréséhez.

Name	Típus	Description
nextLink	string	Folytatási hivatkozás (abszolút URI) a lista következő találatoldalára.
skipToken	string	A következő oldal beolvasásához használt jogkivonat. Null érték esetén nincsenek további lapok.
value	BoundaryMetadata[]	A kért objektumok listája.

BoundaryParentType

Enumerálás

Annak a szülőnek a típusa, amelyhez tartozik. Például Mező, Szezonális mező, Zóna, Recept, PlantTissueAnalysis, ApplicationData, HarvestData, TillageData, PlantingData.

Érték	Description
Field
SeasonalField
Zone
Prescription
PlantTissueAnalysis
ApplicationData
PlantingData
TillageData
HarvestData

Error

Objektum

Az Azure AgPlatform szolgáltatás hibája.

Name	Típus	Description
code	string minLength: 1	Kiszolgáló által definiált hibakódok.
details	Error[]	A jelentett hibához vezető konkrét hibák részleteinek tömbje.
innererror	InnerError	A hibák listáját tartalmazó belső hiba. Lásd az InnerError-referenciadokumentum https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object.
message	string minLength: 1	A hiba emberi olvasásra alkalmas ábrázolása.
target	string	A hiba célja.

ErrorResponse

Objektum

Hibaválasz az Azure AgPlatform szolgáltatástól. Az ErrorResponse referenciadokumentumának https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Típus	Description
error	Error	Az Azure AgPlatform szolgáltatás hibája.
traceId	string	Egyedi nyomkövetési azonosító.

GeoJsonObjectType

Enumerálás

GeoJSON objektumtípus.

Érték	Description
Point
Polygon
MultiPolygon

InnerError

Objektum

A hibák listáját tartalmazó belső hiba. Lásd az InnerError-referenciadokumentum https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object.

Name	Típus	Description
code	string	A hibát tartalmazó hiba által megadottnál meghatározott hibakód.
innererror	InnerError	A hibák listáját tartalmazó belső hiba. Lásd az InnerError-referenciadokumentum https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object.

Measure

Objektum

A mérési adatok és egységek tárolására szolgáló séma.

Name	Típus	Description
unit	string minLength: 1 maxLength: 50	Adategység.
value	number (double)	Adatérték.

MultiPolygon

Objektum

Többpógonyos geometria.

Name	Típus	Description
coordinates	number[] (double)	Lekéri vagy beállítja a GeoJSON-objektum koordinátáit. Többszögből álló tömbnek kell lennie, minden sokszög lineáris gyűrűk listáját tartalmazza. A többszögek több ilyen gyűrűk, az első kell a külső gyűrű, és minden más kell belső gyűrűk.
type	string: MultiPolygon	GeoJSON objektumtípus.

Point

Objektum

Pontgeometria.

Name	Típus	Description
coordinates	number[] (double)	Lekéri vagy beállítja ennek a pontnak a koordinátáját. 2D vagy 3D rendszerekhez 2 vagy 3 elemből álló tömbnek kell lennie.
type	string: Point	GeoJSON objektumtípus.

Polygon

Objektum

Sokszög geometria.

Name	Típus	Description
coordinates	number[] (double)	Lekéri vagy beállítja a GeoJSON-objektum típusát. Lineáris gyűrűs koordinátatömbök tömbjének kell lennie. A többszögek több ilyen gyűrűk, az első kell a külső gyűrű, és minden más kell belső gyűrűk.
type	string: Polygon	GeoJSON objektumtípus.

SearchBoundaryQuery

Objektum

SearchAllBoundaries és SearchBoundaries paraméterek.

Name	Típus	Alapértelmezett érték	Description
ids	string[]		Az erőforrás azonosítói.
intersectsWithGeometry	GeoJsonObject: MultiPolygon Point Polygon		GeoJSON (További részletek: https://geojson.org/). Megjegyzés: A koordináták [Hosszúság, Szélesség] formátumban várhatók.
maxArea	number (double)		A határ maximális kiterjedése (a határt is beleértve).
maxCreatedDateTime	string (date-time)		Az erőforrás létrehozásának maximális dátuma (beleértve az erőforrást is).
maxLastModifiedDateTime	string (date-time)		Az erőforrás utolsó módosításának maximális dátuma (beleértve az erőforrást is).
maxPageSize	integer (int32) minimum: 10 maximum: 1000	50	A szükséges elemek maximális száma (beleértve a elemet is). Minimum = 10, Maximum = 1000, Alapértelmezett érték = 50.
minArea	number (double)		A határ minimális kiterjedése (a határt is beleértve).
minCreatedDateTime	string (date-time)		Az erőforrás minimális létrehozási dátuma (beleértve az erőforrást is).
minLastModifiedDateTime	string (date-time)		Az erőforrás utolsó módosításának minimális dátuma (beleértve az erőforrást is).
names	string[]		Az erőforrás nevei.
parentIds	string[]		Az erőforrás szülőazonosítói.
parentType	BoundaryParentType		Annak a szülőnek a típusa, amelyhez tartozik.
propertyFilters	string[]		A Tulajdonságok objektumon belüli kulcs-érték párokra vonatkozó szűrők. Például: "{testKey} eq {testValue}".
skipToken	string		A következő találatkészlet lekéréséhez hagyja ki a jogkivonatot.
statuses	string[]		Az erőforrás állapota.
type	string		Írja be, hogy a fájlhoz tartozik.