Planting Data - Create Or Update
特定の関係者の下に植え付けデータ リソースを作成または更新します。
PATCH {endpoint}/parties/{partyId}/planting-data/{plantingDataId}?api-version=2023-11-01-preview
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
endpoint
|
path | True |
string uri |
名前空間のホスト名 (例: admaInstanceName.farmbeats.azure.net) |
party
|
path | True |
string |
関連付けられているパーティの ID。 |
planting
|
path | True |
string |
植え付けデータ リソースの ID。 |
api-version
|
query | True |
string |
要求された API バージョン |
要求ヘッダー
Media Types: "application/merge-patch+json"
名前 | 必須 | 型 | 説明 |
---|---|---|---|
Authorization | True |
string |
承認された API 呼び出しに有効なベアラー トークンを指定してください。 以前に認証されていない呼び出しを試した場合は、ブラウザーのキャッシュをクリアする必要がある場合があることに注意してください。 |
要求本文
Media Types: "application/merge-patch+json"
名前 | 型 | 説明 |
---|---|---|
area |
測定読み取りと単位を格納するためのスキーマ。 |
|
associatedResource |
リソースの種類とリソース ID を格納するためのスキーマ。 |
|
avgMaterial |
測定読み取りと単位を格納するためのスキーマ。 |
|
avgPlantingRate |
測定読み取りと単位を格納するためのスキーマ。 |
|
description |
string |
リソースの説明テキスト。 |
geometry | GeoJsonObject: |
GeoJSON (詳細については、 https://geojson.org/)。 注: 座標は [経度,緯度] 形式で指定する必要があります。 |
name |
string |
リソースを識別する名前 |
operationEndDateTime |
string |
操作データの終了日時(サンプル形式: yyyy-MM-ddTHH:mm:ssZ)。 |
operationModifiedDateTime |
string |
操作データの日付/時刻を変更しました。サンプル形式: yyyy-MM-ddTHH:mm:ssZ。 注: これは、ソース プロバイダー自体によって指定されます。 |
operationStartDateTime |
string |
操作データの開始日時(サンプル形式: yyyy-MM-ddTHH:mm:ssZ)。 |
plantingProductDetails |
植え付け製品の詳細。 |
|
properties |
リソースに属するキー値ペアのコレクション。 各ペアは、50 文字を超えるキーを持つ必要があり、150 文字を超える値を持つ必要があります。 注: リソースには最大 25 個のキー値ペアを指定でき、文字列、数字、datetime (yyyy-MM-ddTHH:mm:ssZ) の値のみがサポートされます。 |
|
source |
string |
リソースのソース。 |
status |
string |
リソースの状態。 |
totalMaterial |
測定読み取りと単位を格納するためのスキーマ。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
Success |
|
201 Created |
作成済み |
|
Other Status Codes |
エラー ヘッダー x-ms-error-code: string |
セキュリティ
Authorization
承認された API 呼び出しに有効なベアラー トークンを指定してください。 以前に認証されていない呼び出しを試した場合は、ブラウザーのキャッシュをクリアする必要がある場合があることに注意してください。
型:
apiKey
/:
header
例
PlantingData_CreateOrUpdate
要求のサンプル
PATCH {endpoint}/parties/PARTY123/planting-data/PLANTINGOP123?api-version=2023-11-01-preview
{
"source": "Manual",
"name": "Planting data for North Farm",
"description": "some description",
"status": "Active",
"operationStartDateTime": "2021-02-25T16:57:04Z",
"operationEndDateTime": "2021-02-27T10:13:06Z",
"operationModifiedDateTime": "2021-02-28T10:14:12Z",
"avgPlantingRate": {
"unit": "seedsperacre",
"value": 30
},
"area": {
"unit": "acre",
"value": 30
},
"totalMaterial": {
"unit": "seeds",
"value": 758814
},
"avgMaterial": {
"unit": "seedsperacre",
"value": 25293
},
"plantingProductDetails": [
{
"productName": "VAR1",
"area": {
"unit": "acre",
"value": 20
},
"totalMaterial": {
"unit": "seeds",
"value": 389214
},
"avgMaterial": {
"unit": "seedsperacre",
"value": 19460
}
}
],
"properties": {
"Region": "Europe",
"CountyCode": 123
}
}
応答のサンプル
{
"partyId": "PARTY123",
"id": "PLANTINGOP123",
"source": "Manual",
"name": "Planting data for North Farm",
"description": "some description",
"status": "Active",
"operationStartDateTime": "2021-02-25T16:57:04Z",
"operationEndDateTime": "2021-02-27T10:13:06Z",
"operationModifiedDateTime": "2021-02-28T10:14:12Z",
"avgPlantingRate": {
"unit": "seedsperacre",
"value": 30
},
"area": {
"unit": "acre",
"value": 30
},
"totalMaterial": {
"unit": "seeds",
"value": 758814
},
"avgMaterial": {
"unit": "seedsperacre",
"value": 25293
},
"plantingProductDetails": [
{
"productName": "VAR1",
"area": {
"unit": "acre",
"value": 20
},
"totalMaterial": {
"unit": "seeds",
"value": 389214
},
"avgMaterial": {
"unit": "seedsperacre",
"value": 19460
}
}
],
"properties": {
"Region": "Europe",
"CountyCode": 123
},
"createdDateTime": "2021-04-21T06:49:30Z",
"modifiedDateTime": "2021-04-21T06:49:30Z",
"eTag": "cb00a3ac-0000-0100-0000-601d21ec0000"
}
{
"partyId": "PARTY123",
"id": "PLANTINGOP123",
"source": "Manual",
"name": "Planting data for North Farm",
"description": "some description",
"status": "Active",
"operationStartDateTime": "2021-02-25T16:57:04Z",
"operationEndDateTime": "2021-02-27T10:13:06Z",
"operationModifiedDateTime": "2021-02-28T10:14:12Z",
"avgPlantingRate": {
"unit": "seedsperacre",
"value": 30
},
"area": {
"unit": "acre",
"value": 30
},
"totalMaterial": {
"unit": "seeds",
"value": 758814
},
"avgMaterial": {
"unit": "seedsperacre",
"value": 25293
},
"plantingProductDetails": [
{
"productName": "VAR1",
"area": {
"unit": "acre",
"value": 20
},
"totalMaterial": {
"unit": "seeds",
"value": 389214
},
"avgMaterial": {
"unit": "seedsperacre",
"value": 19460
}
}
],
"properties": {
"Region": "Europe",
"CountyCode": 123
},
"createdDateTime": "2021-04-21T06:49:30Z",
"modifiedDateTime": "2021-04-21T06:49:30Z",
"eTag": "cb00a3ac-0000-0100-0000-601d21ec0000"
}
定義
名前 | 説明 |
---|---|
Error |
Azure AgPlatform サービスからのエラー。 |
Error |
Azure AgPlatform サービスからのエラー応答。 ErrorResponse リファレンス ドキュメントを参照してください https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses 。 |
Farm |
リソースの種類。 |
Geo |
GeoJSON オブジェクトの種類。 |
Geo |
リソースの種類とリソース ID を格納するためのスキーマ。 |
Inner |
エラーの一覧を含む内部エラー。InnerError のリファレンス ドキュメントを参照 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object してください。 |
Measure |
測定読み取りと単位を格納するためのスキーマ。 |
Multi |
MultiPolygon ジオメトリ。 |
Planting |
データ リソースの植え付けのスキーマ。 |
Planting |
製品の詳細を植え付けするためのスキーマ。 |
Point |
ポイント ジオメトリ。 |
Polygon |
ポリゴン ジオメトリ。 |
Error
Azure AgPlatform サービスからのエラー。
名前 | 型 | 説明 |
---|---|---|
code |
string |
サーバー定義のエラー コードのセット。 |
details |
Error[] |
この報告されたエラーの原因となった特定のエラーに関する詳細の配列。 |
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 |
Azure AgPlatform サービスからのエラー。 |
|
traceId |
string |
一意のトレース ID。 |
FarmHierarchyGeoResourceType
リソースの種類。
名前 | 型 | 説明 |
---|---|---|
ApplicationData |
string |
|
Field |
string |
|
HarvestData |
string |
|
PlantTissueAnalysis |
string |
|
PlantingData |
string |
|
Prescription |
string |
|
SeasonalField |
string |
|
TillageData |
string |
|
Zone |
string |
GeoJsonObjectType
GeoJSON オブジェクトの種類。
名前 | 型 | 説明 |
---|---|---|
MultiPolygon |
string |
|
Point |
string |
|
Polygon |
string |
GeoResource
リソースの種類とリソース ID を格納するためのスキーマ。
名前 | 型 | 説明 |
---|---|---|
id |
string |
リソース ID。 |
type |
リソースの種類。 |
InnerError
エラーの一覧を含む内部エラー。InnerError のリファレンス ドキュメントを参照 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object してください。
名前 | 型 | 説明 |
---|---|---|
code |
string |
含まれているエラーによって提供されたエラーコードより具体的なエラー コード。 |
innererror |
エラーの一覧を含む内部エラー。InnerError のリファレンス ドキュメントを参照 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object してください。 |
Measure
測定読み取りと単位を格納するためのスキーマ。
名前 | 型 | 説明 |
---|---|---|
unit |
string |
データ単位。 |
value |
number |
データ値。 |
MultiPolygon
MultiPolygon ジオメトリ。
名前 | 型 | 説明 |
---|---|---|
coordinates |
number[] |
GeoJSON オブジェクトの座標を取得または設定します。 ポリゴンの配列である必要があります。各ポリゴンには線形リングのリストが含まれます。 これらのリングが複数ある多角形の場合、1 つ目は外部リングである必要があり、それ以外の場合は内部リングである必要があります。 |
type | string: |
GeoJSON オブジェクトの種類。 |
PlantingData
データ リソースの植え付けのスキーマ。
名前 | 型 | 説明 |
---|---|---|
area |
測定読み取りと単位を格納するためのスキーマ。 |
|
associatedResource |
リソースの種類とリソース ID を格納するためのスキーマ。 |
|
avgMaterial |
測定読み取りと単位を格納するためのスキーマ。 |
|
avgPlantingRate |
測定読み取りと単位を格納するためのスキーマ。 |
|
createdBy |
string |
ユーザー/テナント ID によって作成されます。 |
createdDateTime |
string |
リソースが作成された日時 (サンプル形式: yyyy-MM-ddTHH:mm:ssZ)。 |
description |
string |
リソースの説明テキスト。 |
eTag |
string |
オプティミスティック コンカレンシーを実装する ETag 値。 |
geometry | GeoJsonObject: |
GeoJSON (詳細については、 https://geojson.org/)。 注: 座標は [経度,緯度] 形式で指定する必要があります。 |
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。 |
plantingProductDetails |
植え付け製品の詳細。 |
|
properties |
リソースに属するキー値ペアのコレクション。 各ペアは、50 文字を超えるキーを持つ必要があり、150 文字を超える値を持つ必要があります。 注: リソースには最大 25 個のキー値ペアを指定でき、文字列、数字、datetime (yyyy-MM-ddTHH:mm:ssZ) の値のみがサポートされます。 |
|
source |
string |
リソースのソース。 |
status |
string |
リソースの状態。 |
totalMaterial |
測定読み取りと単位を格納するためのスキーマ。 |
PlantingProductDetail
製品の詳細を植え付けするためのスキーマ。
名前 | 型 | 説明 |
---|---|---|
area |
測定読み取りと単位を格納するためのスキーマ。 |
|
avgMaterial |
測定読み取りと単位を格納するためのスキーマ。 |
|
productName |
string |
製品の名前。 |
totalMaterial |
測定読み取りと単位を格納するためのスキーマ。 |
Point
ポイント ジオメトリ。
名前 | 型 | 説明 |
---|---|---|
coordinates |
number[] |
このポイントの座標を取得または設定します。 2D または 3D システムの 2 または 3 要素の配列である必要があります。 |
type | string: |
GeoJSON オブジェクトの種類。 |
Polygon
ポリゴン ジオメトリ。
名前 | 型 | 説明 |
---|---|---|
coordinates |
number[] |
GeoJSON オブジェクトの種類を取得または設定します。 線形リング座標配列の配列である必要があります。 これらのリングが複数ある多角形の場合、1 つ目は外部リングである必要があり、それ以外の場合は内部リングである必要があります。 |
type | string: |
GeoJSON オブジェクトの種類。 |