Zones - Create Or Update

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

ゾーン リソースを作成または更新します。

PATCH {endpoint}/parties/{partyId}/zones/{zoneId}?api-version=2023-11-01-preview

URI パラメーター

名前 / 必須 型 説明
endpoint
 path True

string

uri

名前空間のホスト名 (例: admaInstanceName.farmbeats.azure.net)
partyId
 path True

string

パーティ リソースの ID。
zoneId
 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"

名前 型 説明
description

string

リソースの説明テキスト。
geometry GeoJsonObject:

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

string

ゾーンに関連付けられている管理ゾーン ID。
name

string

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

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

string

リソースのソース。
status

string

リソースの状態。
type

string

ゾーンの種類。

応答

名前 型 説明
200 OK

Zone

Success
201 Created

Zone

作成済み
Other Status Codes

ErrorResponse

エラー

ヘッダー

x-ms-error-code: string

セキュリティ

Authorization

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

型: apiKey
/: header

例

Zones_CreateOrUpdate

要求のサンプル

PATCH {endpoint}/parties/PARTY123/zones/Zone123?api-version=2023-11-01-preview

{
  "managementZoneId": "ManagementZone123",
  "type": "Nutrient rich",
  "status": "Active",
  "name": "John Smith's Zone",
  "description": "Some description",
  "source": "source",
  "properties": {
    "Irrigated": "Yes"
  }
}

応答のサンプル

状態コード:
200 
{
  "partyId": "PARTY123",
  "id": "Zone123",
  "managementZoneId": "ManagementZone123",
  "type": "Nutrient rich",
  "status": "Active",
  "name": "John Smith's Zone",
  "description": "Some description",
  "source": "source",
  "properties": {
    "Irrigated": "Yes"
  },
  "createdDateTime": "2021-04-21T06:49:30Z",
  "modifiedDateTime": "2021-04-21T06:49:30Z",
  "createdBy": "00000000-0000-0000-0000-000000000000",
  "modifiedBy": "00000000-0000-0000-0000-000000000000",
  "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e"
}
状態コード:
201 
{
  "partyId": "PARTY123",
  "id": "Zone123",
  "managementZoneId": "ManagementZone123",
  "type": "Nutrient rich",
  "status": "Active",
  "name": "John Smith's Zone",
  "description": "Some description",
  "source": "source",
  "properties": {
    "Irrigated": "Yes"
  },
  "createdDateTime": "2021-04-21T06:49:30Z",
  "modifiedDateTime": "2021-04-21T06:49:30Z",
  "createdBy": "00000000-0000-0000-0000-000000000000",
  "modifiedBy": "00000000-0000-0000-0000-000000000000",
  "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e"
}

定義

名前 説明
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 してください。
MultiPolygon

MultiPolygon ジオメトリ。
Point

ポイント ジオメトリ。
Polygon

多角形のジオメトリ。
Zone

ゾーン オブジェクトの API モデル。

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。

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 オブジェクトの種類。

Zone

ゾーン オブジェクトの API モデル。

名前 型 説明
createdBy

string

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

string

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

string

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

string

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

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

string

一意のリソース ID。
managementZoneId

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

リソースの状態。
type

string

ゾーンの種類。