次の方法で共有


Harvest Data - List

すべての関係者の収集データ リソースのページ分割された一覧を返します。

GET /harvest-data?api-version=2023-06-01-preview
GET /harvest-data?minTotalYield={minTotalYield}&maxTotalYield={maxTotalYield}&minAvgYield={minAvgYield}&maxAvgYield={maxAvgYield}&minTotalWetMass={minTotalWetMass}&maxTotalWetMass={maxTotalWetMass}&minAvgWetMass={minAvgWetMass}&maxAvgWetMass={maxAvgWetMass}&minAvgMoisture={minAvgMoisture}&maxAvgMoisture={maxAvgMoisture}&minAvgSpeed={minAvgSpeed}&maxAvgSpeed={maxAvgSpeed}&sources={sources}&associatedBoundaryIds={associatedBoundaryIds}&minOperationStartDateTime={minOperationStartDateTime}&maxOperationStartDateTime={maxOperationStartDateTime}&minOperationEndDateTime={minOperationEndDateTime}&maxOperationEndDateTime={maxOperationEndDateTime}&minOperationModifiedDateTime={minOperationModifiedDateTime}&maxOperationModifiedDateTime={maxOperationModifiedDateTime}&minArea={minArea}&maxArea={maxArea}&ids={ids}&names={names}&propertyFilters={propertyFilters}&statuses={statuses}&minCreatedDateTime={minCreatedDateTime}&maxCreatedDateTime={maxCreatedDateTime}&minLastModifiedDateTime={minLastModifiedDateTime}&maxLastModifiedDateTime={maxLastModifiedDateTime}&maxPageSize={maxPageSize}&skipToken={skipToken}&api-version=2023-06-01-preview

URI パラメーター

名前 / 必須 説明
api-version
query True

string

要求された API バージョン

associatedBoundaryIds
query

string[]

操作データに関連付けられている境界 ID。

ids
query

string[]

リソースの ID。

maxArea
query

number

double

操作が適用された最大領域 (両端を含む)。

maxAvgMoisture
query

number

double

AvgMoisture の最大値 (両端を含む)。

maxAvgSpeed
query

number

double

最大 AvgSpeed 値 (両端を含む)。

maxAvgWetMass
query

number

double

AvgWetMass の最大値 (両端を含む)。

maxAvgYield
query

number

double

最大 AvgYield 値 (両端を含む)。

maxCreatedDateTime
query

string

date-time

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

maxLastModifiedDateTime
query

string

date-time

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

maxOperationEndDateTime
query

string

date-time

操作データの最大終了日時、サンプル形式: yyyy-MM-ddTHH:mm:ssZ (両端を含む)。

maxOperationModifiedDateTime
query

string

date-time

操作データの最大変更日時、サンプル形式: yyyy-MM-ddTHH:mm:ssZ (両端を含む)。

maxOperationStartDateTime
query

string

date-time

操作データの最大開始日時。サンプル形式: yyyy-MM-ddTHH:mm:ssZ (両端を含む)。

maxPageSize
query

integer

int32

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

maxTotalWetMass
query

number

double

最大合計 WetMass 値 (両端を含む)。

maxTotalYield
query

number

double

最大利回り値 (両端を含む)。

minArea
query

number

double

操作が適用された最小領域 (両端を含む)。

minAvgMoisture
query

number

double

AvgMoisture の最小値 (両端を含む)。

minAvgSpeed
query

number

double

AvgSpeed の最小値 (両端を含む)。

minAvgWetMass
query

number

double

AvgWetMass の最小値 (両端を含む)。

minAvgYield
query

number

double

AvgYield の最小値 (両端を含む)。

minCreatedDateTime
query

string

date-time

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

minLastModifiedDateTime
query

string

date-time

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

minOperationEndDateTime
query

string

date-time

操作データの最小終了日時、サンプル形式: yyyy-MM-ddTHH:mm:ssZ (両端を含む)。

minOperationModifiedDateTime
query

string

date-time

操作データの最小変更日時、サンプル形式: yyyy-MM-ddTHH:mm:ssZ (両端を含む)。

minOperationStartDateTime
query

string

date-time

操作データの最小開始日時、サンプル形式: yyyy-MM-ddTHH:mm:ssZ (両端を含む)。

minTotalWetMass
query

number

double

最小合計 WetMass 値 (両端を含む)。

minTotalYield
query

number

double

最小利回り値 (両端を含む)。

names
query

string[]

リソースの名前。

propertyFilters
query

string[]

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

skipToken
query

string

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

sources
query

string[]

操作データのソース。

statuses
query

string[]

リソースの状態。

要求ヘッダー

名前 必須 説明
Authorization True

string

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

応答

名前 説明
200 OK

HarvestDataListResponse

Success

Other Status Codes

ErrorResponse

エラー

ヘッダー

x-ms-error-code: string

セキュリティ

Authorization

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

型: apiKey
/: header

HarvestData_List

要求のサンプル

GET /harvest-data?api-version=2023-06-01-preview

応答のサンプル

{
  "value": [
    {
      "partyId": "PARTY123",
      "id": "HARVESTOP123",
      "source": "Manual",
      "name": "Harvest data for North Farm",
      "description": "some description",
      "status": "Active",
      "operationStartDateTime": "2021-04-21T06:49:30Z",
      "operationEndDateTime": "2021-04-21T06:49:30Z",
      "operationModifiedDateTime": "2021-04-21T06:49:30Z",
      "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY",
      "area": {
        "unit": "acre",
        "value": 50
      },
      "totalYield": {
        "unit": "kilos",
        "value": 1400
      },
      "avgYield": {
        "unit": "kilosperacre",
        "value": 28
      },
      "totalWetMass": {
        "unit": "kilos",
        "value": 500
      },
      "avgWetMass": {
        "unit": "kilosperacre",
        "value": 10
      },
      "avgMoisture": {
        "unit": "percent",
        "value": 14.61
      },
      "avgSpeed": {
        "unit": "kmsperhour",
        "value": 7.2
      },
      "harvestProductDetails": [
        {
          "productName": "VAR1",
          "area": {
            "unit": "acre",
            "value": 30
          },
          "totalYield": {
            "unit": "kilos",
            "value": 900
          },
          "avgYield": {
            "unit": "kilosperacre",
            "value": 30
          },
          "totalWetMass": {
            "unit": "kilos",
            "value": 300
          },
          "avgWetMass": {
            "unit": "kilosperacre",
            "value": 10
          },
          "avgMoisture": {
            "unit": "percent",
            "value": 16.4
          }
        }
      ],
      "properties": {
        "Region": "Europe",
        "CountyCode": 123
      },
      "attachmentsLink": "https://<resource-name>.farmbeats.azure.net/party/{{partyId}}/attachments?api-version={{apiVersion}}&resourceIds={{harvestDataId}}&resourceTypes=HarvestData",
      "createdDateTime": "2021-04-21T06:49:30Z",
      "modifiedDateTime": "2021-04-21T06:49:30Z",
      "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000"
    }
  ],
  "skipToken": "string",
  "nextLink": "https:/{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/harvestData?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7ehK8eAKzdo1MNnwcAAAAAAA%3d%3d%23RT%3a1%23TRC%3a10%23ISV%3a2%23IEO%3a65551%23FPC%3aAQ2fBwAAAAAAD58HAAAAAAA%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

HarvestData

収集データ リソースのスキーマ。

HarvestDataListResponse

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

HarvestProductDetail

収穫時に使用される製品のスキーマ。

InnerError

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

Measure

測定読み取りと単位を格納するためのスキーマ。

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。

HarvestData

収集データ リソースのスキーマ。

名前 説明
area

Measure

測定読み取りと単位を格納するためのスキーマ。

associatedBoundaryId

string

操作が適用されたフィールドのオプションの境界 ID。

attachmentsLink

string

添付ファイルのリンク。

avgMoisture

Measure

測定読み取りと単位を格納するためのスキーマ。

avgSpeed

Measure

測定読み取りと単位を格納するためのスキーマ。

avgWetMass

Measure

測定読み取りと単位を格納するためのスキーマ。

avgYield

Measure

測定読み取りと単位を格納するためのスキーマ。

createdBy

string

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

createdDateTime

string

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

description

string

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

eTag

string

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

harvestProductDetails

HarvestProductDetail[]

製品の詳細を収集します。

id

string

一意のリソース ID。

modifiedBy

string

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

modifiedDateTime

string

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

name

string

リソースを識別する名前

operationEndDateTime

string

操作データの終了日時(サンプル形式: yyyy-MM-ddTHH:mm:ssZ)。

operationModifiedDateTime

string

操作データの日付/時刻を変更しました。サンプル形式: yyyy-MM-ddTHH:mm:ssZ。 注: これは、ソース プロバイダー自体によって指定されます。

operationStartDateTime

string

操作データの開始日時(サンプル形式: yyyy-MM-ddTHH:mm:ssZ)。

partyId

string

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

properties

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

source

string

リソースのソース。

status

string

リソースの状態。

totalWetMass

Measure

測定読み取りと単位を格納するためのスキーマ。

totalYield

Measure

測定読み取りと単位を格納するためのスキーマ。

HarvestDataListResponse

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

名前 説明
nextLink

string

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

skipToken

string

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

value

HarvestData[]

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

HarvestProductDetail

収穫時に使用される製品のスキーマ。

名前 説明
area

Measure

測定読み取りと単位を格納するためのスキーマ。

avgMoisture

Measure

測定読み取りと単位を格納するためのスキーマ。

avgWetMass

Measure

測定読み取りと単位を格納するためのスキーマ。

avgYield

Measure

測定読み取りと単位を格納するためのスキーマ。

productName

string

製品の名前。

totalWetMass

Measure

測定読み取りと単位を格納するためのスキーマ。

totalYield

Measure

測定読み取りと単位を格納するためのスキーマ。

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 してください。

Measure

測定読み取りと単位を格納するためのスキーマ。

名前 説明
unit

string

データ単位。

value

number

データ値。