Boundaries - Search

서비스:: Azure Data Manager for Agriculture

API 버전:: 2023-06-01-preview

필드 및 교차 기하 도형을 사용하여 모든 당사자의 경계를 검색합니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
api-version	query	True	string	요청된 API 버전

요청 헤더

Name	필수	형식	Description
Authorization	True	string	권한 있는 API 호출에 유효한 전달자 토큰을 제공하세요. 이전에 인증되지 않은 호출을 시도한 경우 브라우저 캐시를 지워야 할 수 있습니다.

요청 본문

Name	형식	Description
ids	string[]	리소스의 ID입니다.
intersectsWithGeometry	GeoJsonObject: MultiPolygon Point Polygon	GeoJSON(자세한 내용은 https://geojson.org/). 참고: 좌표는 [경도, 위도] 형식으로 필요합니다.
maxArea	number (double)	경계의 최대 면적(포함)입니다.
maxCreatedDateTime	string (date-time)	리소스의 최대 생성 날짜(포함)입니다.
maxLastModifiedDateTime	string (date-time)	마지막으로 수정한 최대 리소스 날짜(포함)입니다.
maxPageSize	integer (int32) minimum: 10 maximum: 1000	필요한 최대 항목 수(포함)입니다. 최소 = 10, 최대 = 1000, 기본값 = 50.
minArea	number (double)	경계의 최소 면적(포함)입니다.
minCreatedDateTime	string (date-time)	리소스의 최소 생성 날짜(포함)입니다.
minLastModifiedDateTime	string (date-time)	마지막으로 수정한 리소스의 최소 날짜(포함)입니다.
names	string[]	리소스의 이름입니다.
parentIds	string[]	리소스의 부모 ID입니다.
parentType	BoundaryParentType	속해 있는 부모의 형식입니다.
propertyFilters	string[]	Properties 개체 내의 키-값 쌍을 필터링합니다. 예: "{testKey} eq {testValue}".
skipToken	string	다음 결과 집합을 가져오기 위한 토큰을 건너뜁니다.
statuses	string[]	리소스의 상태입니다.
type	string	속해 있는 형식입니다.

응답

Name	형식	Description
200 OK	BoundaryMetadataListResponse	성공
Other Status Codes	ErrorResponse	오류 헤더 x-ms-error-code: string

Name

형식

Description

200 OK

BoundaryMetadataListResponse

성공

Other Status Codes

ErrorResponse

오류

헤더

x-ms-error-code: string

보안

Authorization

권한 있는 API 호출에 유효한 전달자 토큰을 제공하세요. 이전에 인증되지 않은 호출을 시도한 경우 브라우저 캐시를 지워야 할 수 있습니다.

형식: apiKey
In(다음 안에): header

예제

Boundaries_Search

샘플 요청

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

샘플 응답

상태 코드:: 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"
}

정의

Name	Description
BoundaryMetadata	경계 리소스 메타데이터의 스키마입니다.
BoundaryMetadataListResponse	페이징된 응답에는 요청된 개체 목록과 다음 결과 집합을 가져오는 URL 링크가 포함됩니다.
BoundaryParentType	속해 있는 부모의 형식입니다. 즉, Field, SeasonalField, Zone, Prescription, PlantTissueAnalysis, ApplicationData, HarvestData, TillageData, PlantingData.
Error	Azure AgPlatform 서비스의 오류입니다.
ErrorResponse	Azure AgPlatform 서비스의 오류 응답입니다. ErrorResponse 참조 문서는 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses 참조하세요.
GeoJsonObjectType	GeoJSON 개체 형식입니다.
InnerError	오류 목록을 포함하는 내부 오류입니다. InnerError 참조 문서에 대한 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object 참조하세요.
Measure	측정값 읽기 및 단위를 저장하기 위한 스키마입니다.
MultiPolygon	MultiPolygon 기하 도형입니다.
Point	점 기하 도형입니다.
Polygon	다각형 기하 도형.
SearchBoundaryQuery	SearchAllBoundaries 및 SearchBoundaries 매개 변수

BoundaryMetadata

Object

경계 리소스 메타데이터의 스키마입니다.

Name	형식	Description
area	Measure	측정값 읽기 및 단위를 저장하기 위한 스키마입니다.
createdBy	string	사용자/테넌트 ID로 생성됩니다.
createdDateTime	string (date-time)	리소스를 만든 날짜-시간 샘플 형식: yyyy-MM-ddTHH:mm:ssZ.
description	string minLength: 0 maxLength: 500	리소스에 대한 텍스트 설명입니다.
eTag	string	낙관적 동시성을 구현하는 ETag 값입니다.
id	string	고유 리소스 ID입니다.
modifiedBy	string	사용자/테넌트 ID로 수정되었습니다.
modifiedDateTime	string (date-time)	리소스가 마지막으로 수정된 날짜-시간, 샘플 형식: yyyy-MM-ddTHH:mm:ssZ.
name	string minLength: 0 maxLength: 100	리소스를 식별하는 이름입니다.
parentId	string	속한 부모의 ID입니다.
parentType	BoundaryParentType	속해 있는 부모의 형식입니다.
partyId	string	파티 ID입니다.
properties		리소스에 속하는 키 값 쌍의 컬렉션입니다. 각 쌍에는 50자보다 큰 키가 없어야 하며 150자보다 큰 값은 없어야 합니다. 참고: 리소스에 대해 최대 25개의 키 값 쌍을 제공할 수 있으며 문자열, 숫자 및 datetime(yyyy-MM-ddTHH:mm:ssZ) 값만 지원됩니다.
source	string minLength: 2 maxLength: 100	리소스의 원본입니다.
status	string minLength: 0 maxLength: 100	리소스의 상태입니다.
type	string	속해 있는 형식입니다.

BoundaryMetadataListResponse

Object

페이징된 응답에는 요청된 개체 목록과 다음 결과 집합을 가져오는 URL 링크가 포함됩니다.

Name	형식	Description
nextLink	string	목록의 결과 다음 페이지에 대한 연속 링크(절대 URI)입니다.
skipToken	string	다음 페이지를 검색하는 데 사용되는 토큰입니다. null이면 추가 페이지가 없습니다.
value	BoundaryMetadata[]	요청된 개체 목록입니다.

BoundaryParentType

열거형

속해 있는 부모의 형식입니다. 즉, Field, SeasonalField, Zone, Prescription, PlantTissueAnalysis, ApplicationData, HarvestData, TillageData, PlantingData.

값	Description
Field
SeasonalField
Zone
Prescription
PlantTissueAnalysis
ApplicationData
PlantingData
TillageData
HarvestData

Error

Object

Azure AgPlatform 서비스의 오류입니다.

Name	형식	Description
code	string minLength: 1	서버에서 정의한 오류 코드 집합입니다.
details	Error[]	이 보고된 오류로 이어진 특정 오류에 대한 세부 정보 배열입니다.
innererror	InnerError	오류 목록을 포함하는 내부 오류입니다. InnerError 참조 문서에 대한 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object 참조하세요.
message	string minLength: 1	사람이 읽을 수 있는 오류 표현입니다.
target	string	오류의 대상입니다.

ErrorResponse

Object

Azure AgPlatform 서비스의 오류 응답입니다. ErrorResponse 참조 문서는 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses 참조하세요.

Name	형식	Description
error	Error	Azure AgPlatform 서비스의 오류입니다.
traceId	string	고유 추적 ID입니다.

GeoJsonObjectType

열거형

GeoJSON 개체 형식입니다.

값	Description
Point
Polygon
MultiPolygon

InnerError

Object

오류 목록을 포함하는 내부 오류입니다. InnerError 참조 문서에 대한 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object 참조하세요.

Name	형식	Description
code	string	포함된 오류에서 제공한 것보다 구체적인 오류 코드입니다.
innererror	InnerError	오류 목록을 포함하는 내부 오류입니다. InnerError 참조 문서에 대한 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object 참조하세요.

Measure

Object

측정값 읽기 및 단위를 저장하기 위한 스키마입니다.

Name	형식	Description
unit	string minLength: 1 maxLength: 50	데이터 단위입니다.
value	number (double)	데이터 값입니다.

MultiPolygon

Object

MultiPolygon 기하 도형입니다.

Name	형식	Description
coordinates	number[] (double)	GeoJSON 개체의 좌표를 가져오거나 설정합니다. 다각형 배열이어야 하며, 각 다각형에는 선형 링 목록이 포함되어 있습니다. 이러한 링 중 하나 이상이 있는 다각형의 경우 첫 번째는 외부 링이어야 하며 다른 모든 링은 내부 링이어야 합니다.
type	string: MultiPolygon	GeoJSON 개체 형식입니다.

Point

Object

점 기하 도형입니다.

Name	형식	Description
coordinates	number[] (double)	이 점의 좌표를 가져오거나 설정합니다. 2D 또는 3D 시스템의 경우 2개 또는 3개 요소의 배열이어야 합니다.
type	string: Point	GeoJSON 개체 형식입니다.

Polygon

Object

다각형 기하 도형.

Name	형식	Description
coordinates	number[] (double)	GeoJSON 개체의 형식을 가져오거나 설정합니다. 선형 링 좌표 배열의 배열이어야 합니다. 이러한 링 중 하나 이상이 있는 다각형의 경우 첫 번째는 외부 링이어야 하며 다른 모든 링은 내부 링이어야 합니다.
type	string: Polygon	GeoJSON 개체 형식입니다.

SearchBoundaryQuery

Object

SearchAllBoundaries 및 SearchBoundaries 매개 변수

Name	형식	Default value	Description
ids	string[]		리소스의 ID입니다.
intersectsWithGeometry	GeoJsonObject: MultiPolygon Point Polygon		GeoJSON(자세한 내용은 https://geojson.org/). 참고: 좌표는 [경도, 위도] 형식으로 필요합니다.
maxArea	number (double)		경계의 최대 면적(포함)입니다.
maxCreatedDateTime	string (date-time)		리소스의 최대 생성 날짜(포함)입니다.
maxLastModifiedDateTime	string (date-time)		마지막으로 수정한 최대 리소스 날짜(포함)입니다.
maxPageSize	integer (int32) minimum: 10 maximum: 1000	50	필요한 최대 항목 수(포함)입니다. 최소 = 10, 최대 = 1000, 기본값 = 50.
minArea	number (double)		경계의 최소 면적(포함)입니다.
minCreatedDateTime	string (date-time)		리소스의 최소 생성 날짜(포함)입니다.
minLastModifiedDateTime	string (date-time)		마지막으로 수정한 리소스의 최소 날짜(포함)입니다.
names	string[]		리소스의 이름입니다.
parentIds	string[]		리소스의 부모 ID입니다.
parentType	BoundaryParentType		속해 있는 부모의 형식입니다.
propertyFilters	string[]		Properties 개체 내의 키-값 쌍을 필터링합니다. 예: "{testKey} eq {testValue}".
skipToken	string		다음 결과 집합을 가져오기 위한 토큰을 건너뜁니다.
statuses	string[]		리소스의 상태입니다.
type	string		속해 있는 형식입니다.

다음을 통해 공유

Boundaries - Search

URI 매개 변수

요청 헤더

요청 본문

응답

보안

Authorization

예제

Boundaries_Search

샘플 요청

샘플 응답

정의

BoundaryMetadata

BoundaryMetadataListResponse

BoundaryParentType

Error

ErrorResponse

GeoJsonObjectType

InnerError

Measure

MultiPolygon

Point

Polygon

SearchBoundaryQuery