次の方法で共有

Fields - Search

  • リファレンス
サービス:
Azure Data Manager for Agriculture
API バージョン:
2023-11-01-preview

ジオメトリを交差させて、すべての関係者のフィールドを検索します。

POST {endpoint}/fields:search?api-version=2023-11-01-preview
省略可能なパラメーターを含む: 
POST {endpoint}/fields:search?skipToken={skipToken}&maxPageSize={maxPageSize}&api-version=2023-11-01-preview

URI パラメーター

名前 / 必須 型 説明
endpoint
 path True

string

uri

名前空間のホスト名 (例: admaInstanceName.farmbeats.azure.net)
api-version
 query True

string

要求された API バージョン
maxPageSize
 query

integer

int32

必要な項目の最大数 (含む)。 Minimum = 10、Maximum = 1000、既定値 = 50。
skipToken
 query

string

次の結果セットを取得するためのトークンをスキップします。

要求ヘッダー

名前 必須 型 説明
Authorization True

string

承認された API 呼び出しに有効なベアラー トークンを指定してください。 以前に認証されていない呼び出しを試した場合は、ブラウザーのキャッシュをクリアする必要がある場合があることに注意してください。

要求本文

名前 型 説明
farmIds

string[]

リソースの FarmId。
ids

string[]

リソースの ID。
intersectsWithGeometry GeoJsonObject:

GeoJSON (詳細については、 https://geojson.org/)。 注: 座標は [経度,緯度] 形式で指定する必要があります。
maxCreatedDateTime

string

リソースの最大作成日 (含む)。
maxLastModifiedDateTime

string

リソースの最終更新日の最大値 (含む)。
minCreatedDateTime

string

リソースの最小作成日 (含む)。
minLastModifiedDateTime

string

リソースの最終更新日の最小値 (含む)。
names

string[]

リソースの名前。
partyId

string

操作データに属するパーティ ID。
propertyFilters

string[]

Properties オブジェクト内のキーと値のペアをフィルター処理します。 例: "{testKey} eq {testValue}"
statuses

string[]

リソースの状態。

応答

名前 型 説明
200 OK

FieldMetaDataListResponse

Success
Other Status Codes

ErrorResponse

エラー

ヘッダー

x-ms-error-code: string

セキュリティ

Authorization

承認された API 呼び出しに有効なベアラー トークンを指定してください。 以前に認証されていない呼び出しを試した場合は、ブラウザーのキャッシュをクリアする必要がある場合があることに注意してください。

型: apiKey
/: header

例

要求のサンプル

POST {endpoint}/fields:search?maxPageSize=50&api-version=2023-11-01-preview

{
  "intersectsWithGeometry": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          73.70457172393799,
          20.545385304358106
        ],
        [
          73.70457172393799,
          20.545385304358106
        ],
        [
          73.70448589324951,
          20.542411534243367
        ],
        [
          73.70877742767334,
          20.541688176010233
        ],
        [
          73.71023654937744,
          20.545083911372505
        ],
        [
          73.70663166046143,
          20.546992723579137
        ],
        [
          73.70457172393799,
          20.545385304358106
        ]
      ]
    ]
  }
}

応答のサンプル

状態コード:
200 
{
  "value": [
    {
      "id": "FIELD123",
      "partyId": "FARMER123",
      "farmId": "FARM123",
      "name": "John Smith's Field",
      "status": "Active",
      "description": "Some description",
      "properties": {
        "Irrigated": "Yes",
        "RetailerId": "Retailer123"
      },
      "createdDateTime": "2021-04-21T06:49:30Z",
      "modifiedDateTime": "2021-04-21T06:49:30Z",
      "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e"
    }
  ],
  "skipToken": "string",
  "nextLink": "https://{{resourceName}}.farmbeats.azure.net/farmers/{{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"
}

定義

名前 説明
Error

Azure AgPlatform サービスからのエラー。
ErrorResponse

Azure AgPlatform サービスからのエラー応答。 ErrorResponse リファレンス ドキュメントを参照してください https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses 。
FieldMetaData

フィールド リソースのスキーマ。
FieldMetaDataListResponse

ページ応答には、要求されたオブジェクトの一覧と、次の結果セットを取得するための skipToken が含まれています。
GeoJsonObjectType

GeoJSON オブジェクトの種類。
InnerError

エラーの一覧を含む内部エラー。InnerError のリファレンス ドキュメントを参照 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object してください。
MultiPolygon

MultiPolygon ジオメトリ。
Point

ポイント ジオメトリ。
Polygon

ポリゴン ジオメトリ。
SearchFieldQuery

SearchAllBoundaries パラメーターと SearchBoundaries パラメーター。

Error

Azure AgPlatform サービスからのエラー。

名前 型 説明
code

string

サーバー定義のエラー コードのセット。
details

Error[]

この報告されたエラーの原因となった特定のエラーに関する詳細の配列。
innererror

InnerError

エラーの一覧を含む内部エラー。InnerError のリファレンス ドキュメントを参照 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object してください。
message

string

人が判読できるエラーの表現。
target

string

エラーのターゲット。

ErrorResponse

Azure AgPlatform サービスからのエラー応答。 ErrorResponse リファレンス ドキュメントを参照してください https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses 。

名前 型 説明
error

Error

Azure AgPlatform サービスからのエラー。
traceId

string

一意のトレース ID。

FieldMetaData

フィールド リソースのスキーマ。

名前 型 説明
createdBy

string

ユーザー/テナント ID によって作成されます。
createdDateTime

string

リソースが作成された日時 (サンプル形式: yyyy-MM-ddTHH:mm:ssZ)。
description

string

リソースの説明テキスト。
eTag

string

オプティミスティック コンカレンシーを実装する ETag 値。
farmId

string

関連付けられているファームの ID。
id

string

一意のリソース ID。
modifiedBy

string

ユーザー/テナント ID によって変更されました。
modifiedDateTime

string

リソースが最後に変更された日時 (サンプル形式: yyyy-MM-ddTHH:mm:ssZ)。
name

string

リソースを識別する名前
partyId

string

パーティ ID。
properties

リソースに属するキー値ペアのコレクション。 各ペアは、50 文字を超えるキーを持つ必要があり、150 文字を超える値を持つ必要があります。 注: リソースには最大 25 個のキー値ペアを指定でき、文字列、数字、datetime (yyyy-MM-ddTHH:mm:ssZ) の値のみがサポートされます。
source

string

リソースのソース。
status

string

リソースの状態。

FieldMetaDataListResponse

ページ応答には、要求されたオブジェクトの一覧と、次の結果セットを取得するための skipToken が含まれています。

名前 型 説明
nextLink

string

一覧にある結果の次のページへの継続リンク (絶対 URI)
skipToken

string

次のページの取得に使用されるトークン。 null の場合、追加のページはありません。
value

FieldMetaData[]

要求されたオブジェクトの一覧。

GeoJsonObjectType

GeoJSON オブジェクトの種類。

名前 型 説明
MultiPolygon

string

Point

string

Polygon

string

InnerError

エラーの一覧を含む内部エラー。InnerError のリファレンス ドキュメントを参照 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object してください。

名前 型 説明
code

string

含まれているエラーによって提供されたエラーコードより具体的なエラー コード。
innererror

InnerError

エラーの一覧を含む内部エラー。InnerError のリファレンス ドキュメントを参照 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object してください。

MultiPolygon

MultiPolygon ジオメトリ。

名前 型 説明
coordinates

number[]

GeoJSON オブジェクトの座標を取得または設定します。 ポリゴンの配列である必要があります。各ポリゴンには線形リングのリストが含まれます。 これらのリングが複数ある多角形の場合、1 つ目は外部リングである必要があり、それ以外の場合は内部リングである必要があります。
type string:

MultiPolygon

GeoJSON オブジェクトの種類。

Point

ポイント ジオメトリ。

名前 型 説明
coordinates

number[]

このポイントの座標を取得または設定します。 2D または 3D システムの 2 または 3 要素の配列である必要があります。
type string:

Point

GeoJSON オブジェクトの種類。

Polygon

ポリゴン ジオメトリ。

名前 型 説明
coordinates

number[]

GeoJSON オブジェクトの種類を取得または設定します。 線形リング座標配列の配列である必要があります。 これらのリングが複数ある多角形の場合、1 つ目は外部リングである必要があり、それ以外の場合は内部リングである必要があります。
type string:

Polygon

GeoJSON オブジェクトの種類。

SearchFieldQuery

SearchAllBoundaries パラメーターと SearchBoundaries パラメーター。

名前 型 説明
farmIds

string[]

リソースの FarmId。
ids

string[]

リソースの ID。
intersectsWithGeometry GeoJsonObject:

GeoJSON (詳細については、 https://geojson.org/)。 注: 座標は [経度,緯度] 形式で指定する必要があります。
maxCreatedDateTime

string

リソースの最大作成日 (含む)。
maxLastModifiedDateTime

string

リソースの最終更新日の最大値 (含む)。
minCreatedDateTime

string

リソースの最小作成日 (含む)。
minLastModifiedDateTime

string

リソースの最終更新日の最小値 (含む)。
names

string[]

リソースの名前。
partyId

string

操作データに属するパーティ ID。
propertyFilters

string[]

Properties オブジェクト内のキーと値のペアをフィルター処理します。 例: "{testKey} eq {testValue}"
statuses

string[]

リソースの状態。