Boundaries - Search

Tjänst:: Azure Data Manager for Agriculture

API-version:: 2023-06-01-preview

Sök efter gränser mellan alla parter efter fält och korsande geometri.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
api-version	query	True	string	Den begärda API-versionen

Begärandehuvud

Name	Obligatorisk	Typ	Description
Authorization	True	string	Ange en giltig ägartoken för auktoriserade API-anrop. Observera att du kan behöva rensa webbläsarens cacheminne om du har provat oautentiserade anrop tidigare.

Begärandetext

Name	Typ	Description
ids	string[]	ID:t för resursen.
intersectsWithGeometry	GeoJsonObject: MultiPolygon Point Polygon	GeoJSON (För mer information: https://geojson.org/). Obs! Koordinater förväntas i formatet [Longitud, Latitud].
maxArea	number (double)	Maximal areal av gränsen (inklusive).
maxCreatedDateTime	string (date-time)	Maximalt skapandedatum för resurs (inklusive).
maxLastModifiedDateTime	string (date-time)	Maximalt senast ändrat datum för resursen (inklusive).
maxPageSize	integer (int32) minimum: 10 maximum: 1000	Maximalt antal objekt som behövs (inklusive). Minimum = 10, Maximum = 1000, Standardvärde = 50.
minArea	number (double)	Minsta areal av gränsen (inklusive).
minCreatedDateTime	string (date-time)	Minsta skapandedatum för resursen (inklusive).
minLastModifiedDateTime	string (date-time)	Minsta senaste ändringsdatum för resursen (inklusive).
names	string[]	Namn på resursen.
parentIds	string[]	Överordnat ID för resursen.
parentType	BoundaryParentType	Typ av överordnad som den tillhör.
propertyFilters	string[]	Filtrerar på nyckel/värde-par i objektet Egenskaper. t.ex. "{testKey} eq {testValue}".
skipToken	string	Hoppa över token för att hämta nästa uppsättning resultat.
statuses	string[]	Status för resursen.
type	string	Skriv den som tillhör.

Svar

Name	Typ	Description
200 OK	BoundaryMetadataListResponse	Framgång
Other Status Codes	ErrorResponse	Fel Sidhuvuden x-ms-error-code: string

Name

Typ

Description

200 OK

BoundaryMetadataListResponse

Framgång

Other Status Codes

ErrorResponse

Fel

Sidhuvuden

x-ms-error-code: string

Säkerhet

Authorization

Ange en giltig ägartoken för auktoriserade API-anrop. Observera att du kan behöva rensa webbläsarens cacheminne om du har provat oautentiserade anrop tidigare.

Typ: apiKey
I: header

Exempel

Boundaries_Search

Exempelbegäran

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

Exempelsvar

Statuskod:: 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"
}

Definitioner

Name	Description
BoundaryMetadata	Schema för gränsresursmetadata.
BoundaryMetadataListResponse	Sidsidigt svar innehåller en lista över begärda objekt och en URL-länk för att hämta nästa uppsättning resultat.
BoundaryParentType	Typ av överordnad som den tillhör. d.v.s. Field, SeasonalField, Zone, Prescription, PlantTissueAnalysis, ApplicationData, HarvestData, TillageData, PlantingData.
Error	Ett fel från Azure AgPlatform-tjänsten.
ErrorResponse	Ett felsvar från Azure AgPlatform-tjänsten. Se https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses för ErrorResponse-referensdokumentet.
GeoJsonObjectType	GeoJSON-objekttyp.
InnerError	Inre fel som innehåller en lista över fel. Se referensdokumentet https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object för InnerError.
Measure	Schema för att lagra mätningsläsning och enhet.
MultiPolygon	MultiPolygongeometri.
Point	Punktgeometri.
Polygon	Polygongeometri.
SearchBoundaryQuery	Parametrarna SearchAllBoundaries och SearchBoundaries.

BoundaryMetadata

Objekt

Schema för gränsresursmetadata.

Name	Typ	Description
area	Measure	Schema för att lagra mätningsläsning och enhet.
createdBy	string	Skapad av användar-/klient-ID.
createdDateTime	string (date-time)	Datum-tid när resursen skapades, exempelformat: åååå-MM-ddTHH:mm:ssZ.
description	string minLength: 0 maxLength: 500	Textbeskrivning av resursen.
eTag	string	ETag-värdet för att implementera optimistisk samtidighet.
id	string	Unikt resurs-ID.
modifiedBy	string	Ändrat av användar-/klient-ID.
modifiedDateTime	string (date-time)	Datum-tid när resursen senast ändrades, exempelformat: åååå-MM-ddTHH:mm:ssZ.
name	string minLength: 0 maxLength: 100	Namn för att identifiera resursen.
parentId	string	ID för den överordnade som den tillhör.
parentType	BoundaryParentType	Typ av överordnad som den tillhör.
partyId	string	Party-ID.
properties		En samling nyckelvärdepar som tillhör resursen. Varje par får inte ha en nyckel som är större än 50 tecken och får inte ha ett värde som är större än 150 tecken. Obs! Högst 25 nyckelvärdepar kan anges för en resurs och endast värden för sträng, siffror och datetime (åååå-MM-ddTHH:mm:ssZ) stöds.
source	string minLength: 2 maxLength: 100	Resursens källa.
status	string minLength: 0 maxLength: 100	Status för resursen.
type	string	Skriv den som tillhör.

BoundaryMetadataListResponse

Objekt

Sidsidigt svar innehåller en lista över begärda objekt och en URL-länk för att hämta nästa uppsättning resultat.

Name	Typ	Description
nextLink	string	Fortsättningslänk (absolut URI) till nästa sida med resultat i listan.
skipToken	string	Token som används för att hämta nästa sida. Om värdet är null finns det inga ytterligare sidor.
value	BoundaryMetadata[]	Lista över begärda objekt.

BoundaryParentType

Uppräkning

Typ av överordnad som den tillhör. d.v.s. Field, SeasonalField, Zone, Prescription, PlantTissueAnalysis, ApplicationData, HarvestData, TillageData, PlantingData.

Värde	Description
Field
SeasonalField
Zone
Prescription
PlantTissueAnalysis
ApplicationData
PlantingData
TillageData
HarvestData

Error

Objekt

Ett fel från Azure AgPlatform-tjänsten.

Name	Typ	Description
code	string minLength: 1	Serverdefinierad uppsättning felkoder.
details	Error[]	Matris med information om specifika fel som ledde till det rapporterade felet.
innererror	InnerError	Inre fel som innehåller en lista över fel. Se referensdokumentet https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object för InnerError.
message	string minLength: 1	Mänsklig läsbar representation av felet.
target	string	Målet för felet.

ErrorResponse

Objekt

Ett felsvar från Azure AgPlatform-tjänsten. Se https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses för ErrorResponse-referensdokumentet.

Name	Typ	Description
error	Error	Ett fel från Azure AgPlatform-tjänsten.
traceId	string	Unikt spårnings-ID.

GeoJsonObjectType

Uppräkning

GeoJSON-objekttyp.

Värde	Description
Point
Polygon
MultiPolygon

InnerError

Objekt

Inre fel som innehåller en lista över fel. Se referensdokumentet https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object för InnerError.

Name	Typ	Description
code	string	Specifik felkod än vad som angavs av det innehållande felet.
innererror	InnerError	Inre fel som innehåller en lista över fel. Se referensdokumentet https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object för InnerError.

Measure

Objekt

Schema för att lagra mätningsläsning och enhet.

Name	Typ	Description
unit	string minLength: 1 maxLength: 50	Dataenhet.
value	number (double)	Datavärde.

MultiPolygon

Objekt

MultiPolygongeometri.

Name	Typ	Description
coordinates	number[] (double)	Hämtar eller anger koordinater för GeoJSON-objekt. Det måste vara en matris med polygoner, varje polygon innehåller en lista över linjära ringar. För Polygoner med mer än en av dessa ringar måste den första vara den yttre ringen, och alla andra måste vara inre ringar.
type	string: MultiPolygon	GeoJSON-objekttyp.

Point

Objekt

Punktgeometri.

Name	Typ	Description
coordinates	number[] (double)	Hämtar eller anger koordinaten för den här punkten. Det måste vara en matris med 2 eller 3 element för ett 2D- eller 3D-system.
type	string: Point	GeoJSON-objekttyp.

Polygon

Objekt

Polygongeometri.

Name	Typ	Description
coordinates	number[] (double)	Hämtar eller anger typ av GeoJSON-objekt. Det måste vara en matris med linjära ringkoordinatmatriser. För Polygoner med mer än en av dessa ringar måste den första vara den yttre ringen, och alla andra måste vara inre ringar.
type	string: Polygon	GeoJSON-objekttyp.

SearchBoundaryQuery

Objekt

Parametrarna SearchAllBoundaries och SearchBoundaries.

Name	Typ	Standardvärde	Description
ids	string[]		ID:t för resursen.
intersectsWithGeometry	GeoJsonObject: MultiPolygon Point Polygon		GeoJSON (För mer information: https://geojson.org/). Obs! Koordinater förväntas i formatet [Longitud, Latitud].
maxArea	number (double)		Maximal areal av gränsen (inklusive).
maxCreatedDateTime	string (date-time)		Maximalt skapandedatum för resurs (inklusive).
maxLastModifiedDateTime	string (date-time)		Maximalt senast ändrat datum för resursen (inklusive).
maxPageSize	integer (int32) minimum: 10 maximum: 1000	50	Maximalt antal objekt som behövs (inklusive). Minimum = 10, Maximum = 1000, Standardvärde = 50.
minArea	number (double)		Minsta areal av gränsen (inklusive).
minCreatedDateTime	string (date-time)		Minsta skapandedatum för resursen (inklusive).
minLastModifiedDateTime	string (date-time)		Minsta senaste ändringsdatum för resursen (inklusive).
names	string[]		Namn på resursen.
parentIds	string[]		Överordnat ID för resursen.
parentType	BoundaryParentType		Typ av överordnad som den tillhör.
propertyFilters	string[]		Filtrerar på nyckel/värde-par i objektet Egenskaper. t.ex. "{testKey} eq {testValue}".
skipToken	string		Hoppa över token för att hämta nästa uppsättning resultat.
statuses	string[]		Status för resursen.
type	string		Skriv den som tillhör.

Dela via

Boundaries - Search

URI-parametrar

Begärandehuvud

Begärandetext

Svar

Säkerhet

Authorization

Exempel

Boundaries_Search

Exempelbegäran

Exempelsvar

Definitioner

BoundaryMetadata

BoundaryMetadataListResponse

BoundaryParentType

Error

ErrorResponse

GeoJsonObjectType

InnerError

Measure

MultiPolygon

Point

Polygon

SearchBoundaryQuery