Seasonal Fields - Create Or Update

Başvuru

Hizmet:: Azure Data Manager for Agriculture

API Sürümü:: 2023-11-01-preview

Belirli bir taraf altında mevsimsel bir alan kaynağı oluşturur veya Güncelleştirmeler.

PATCH {endpoint}/parties/{partyId}/seasonal-fields/{seasonalFieldId}?api-version=2023-11-01-preview

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
endpoint	path	True	string uri	Ad alanının ana bilgisayar adı, örneğin admaInstanceName.farmbeats.azure.net
partyId	path	True	string	İlişkili taraf kaynağının kimliği.
seasonalFieldId	path	True	string	Mevsimlik alan kaynağının kimliği.
api-version	query	True	string	İstenen API sürümü

İstek Başlığı

Media Types: "application/merge-patch+json"

Name	Gerekli	Tür	Description
Authorization	True	string	Lütfen yetkili API çağrıları için geçerli bir taşıyıcı belirteci sağlayın. Kimliği doğrulanmamış çağrıları daha önce denediyseniz tarayıcı önbelleğinizi temizlemeniz gerekebileceğini unutmayın.

İstek Gövdesi

Media Types: "application/merge-patch+json"

Name	Gerekli	Tür	Description
farmId	True	string	İlişkili Grup kimliği.
cropId		string	Ait olduğu kırpmanın kimliği.
cropProductIds		string[]	CropProduct kimlikleri.
description		string	Kaynağın metinsel açıklaması.
fieldId		string	İlişkili Alanın kimliği.
geometry		GeoJsonObject: MultiPolygon Point Polygon	GeoJSON (Daha fazla ayrıntı için: https://geojson.org/). Not: Koordinatlar [Boylam, Enlem] biçiminde beklenir.
name		string	Kaynağı tanımlamak için ad.
properties			Kaynağa ait anahtar değer çiftleri koleksiyonu. Her çiftin anahtarı 50 karakterden büyük olmamalıdır ve 150 karakterden büyük bir değere sahip olmamalıdır. Not: Bir kaynak için en fazla 25 anahtar değer çifti sağlanabilir ve yalnızca dize, sayı ve tarih saat (yyyy-MM-ddTHH:mm:ssZ) değerleri desteklenir.
seasonId		string	Ait olduğu mevsimin kimliği.
source		string	Kaynağın kaynağı.
status		string	Kaynağın durumu.

Yanıtlar

Name

Tür

Description

200 OK

Başarılı

201 Created

Oluşturulan

Other Status Codes

Hata

Üst Bilgiler

x-ms-error-code: string

Güvenlik

Authorization

Lütfen yetkili API çağrıları için geçerli bir taşıyıcı belirteci sağlayın. Kimliği doğrulanmamış çağrıları daha önce denediyseniz tarayıcı önbelleğinizi temizlemeniz gerekebileceğini unutmayın.

Tür: apiKey
İçinde: header

Örnekler

SeasonalFields_CreateOrUpdate

Örnek isteği

HTTP

PATCH {endpoint}/parties/PARTY123/seasonal-fields/SEASONALFIELD123?api-version=2023-11-01-preview

{
  "farmId": "FARM123",
  "fieldId": "FIELD123",
  "seasonId": "WINTER_WHEAT_2021",
  "cropId": "WHEAT",
  "name": "John Smith's Seasonal Field",
  "status": "Active",
  "description": "Some description",
  "source": "source",
  "properties": {
    "Irrigated": "Yes",
    "RetailerId": "Retailer123"
  }
}

Örnek yanıt

Durum kodu:: 200

{
  "id": "SEASONALFIELD123",
  "partyId": "PARTY123",
  "farmId": "FARM123",
  "fieldId": "FIELD123",
  "seasonId": "WINTER_WHEAT_2021",
  "cropId": "WHEAT",
  "name": "John Smith's Seasonal Field",
  "status": "Active",
  "description": "Some description",
  "source": "source",
  "properties": {
    "Irrigated": "Yes",
    "RetailerId": "Retailer123"
  },
  "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"
}

Durum kodu:: 201

{
  "id": "SEASONALFIELD123",
  "partyId": "PARTY123",
  "farmId": "FARM123",
  "fieldId": "FIELD123",
  "seasonId": "WINTER_WHEAT_2021",
  "cropId": "WHEAT",
  "name": "John Smith's Seasonal Field",
  "status": "Active",
  "description": "Some description",
  "source": "source",
  "properties": {
    "Irrigated": "Yes",
    "RetailerId": "Retailer123"
  },
  "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"
}

Tanımlar

Name	Description
Error	Azure AgPlatform hizmetinden bir hata.
ErrorResponse	Azure AgPlatform hizmetinden bir hata yanıtı. ErrorResponse başvuru belgesi için bkz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses .
GeoJsonObjectType	GeoJSON nesne türü.
InnerError	Hata listesini içeren iç hata. InnerError başvuru belgesi için bkz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object .
MultiPolygon	MultiPolygon geometrisi.
Point	Nokta geometrisi.
Polygon	Çokgen geometri.
SeasonalField	Mevsimlik alan kaynağının şeması.

Error

Azure AgPlatform hizmetinden bir hata.

Name	Tür	Description
code	string	Sunucu tanımlı hata kodları kümesi.
details	Error[]	Bu bildirilen hataya yol açan belirli hatalarla ilgili ayrıntılar dizisi.
innererror	InnerError	Hata listesini içeren iç hata. InnerError başvuru belgesi için bkz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object .
message	string	Hatanın insan tarafından okunabilen gösterimi.
target	string	Hatanın hedefi.

ErrorResponse

Azure AgPlatform hizmetinden bir hata yanıtı. ErrorResponse başvuru belgesi için bkz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses .

Name	Tür	Description
error	Error	Azure AgPlatform hizmetinden bir hata.
traceId	string	Benzersiz izleme kimliği.

GeoJsonObjectType

GeoJSON nesne türü.

Name	Tür	Description
MultiPolygon	string
Point	string
Polygon	string

InnerError

Hata listesini içeren iç hata. InnerError başvuru belgesi için bkz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object .

Name	Tür	Description
code	string	İçeren hata tarafından sağlanandan özel hata kodu.
innererror	InnerError	Hata listesini içeren iç hata. InnerError başvuru belgesi için bkz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object .

MultiPolygon

MultiPolygon geometrisi.

Name	Tür	Description
coordinates	number[]	GeoJSON Nesnesinin Koordinatlarını alır veya ayarlar. Bu bir çokgen dizisi olmalıdır, her çokgen doğrusal halkaların listesini içerir. Bu halkalardan birden fazlasına sahip Çokgenler için, ilk dış halka OLMALı ve diğerleri iç halkaLAR OLMALIDIR.
type	string: MultiPolygon	GeoJSON nesne türü.

Point

Nokta geometrisi.

Name	Tür	Description
coordinates	number[]	Bu noktanın koordinatını alır veya ayarlar. 2B veya 3B sistem için 2 veya 3 öğeden oluşan bir dizi olmalıdır.
type	string: Point	GeoJSON nesne türü.

Polygon

Çokgen geometri.

Name	Tür	Description
coordinates	number[]	GeoJSON Nesnesinin türünü alır veya ayarlar. Doğrusal halka koordinat dizilerinden oluşan bir dizi olmalıdır. Bu halkalardan birden fazlasına sahip Çokgenler için, ilk dış halka OLMALı ve diğerleri iç halkaLAR OLMALIDIR.
type	string: Polygon	GeoJSON nesne türü.

SeasonalField

Mevsimlik alan kaynağının şeması.

Name	Tür	Description
createdBy	string	Kullanıcı/kiracı kimliği tarafından oluşturuldu.
createdDateTime	string	Kaynağın oluşturulduğu tarih-saat, örnek biçim: yyyy-MM-ddTHH:mm:ssZ.
cropId	string	Ait olduğu kırpmanın kimliği.
cropProductIds	string[]	CropProduct kimlikleri.
description	string	Kaynağın metinsel açıklaması.
eTag	string	İyimser eşzamanlılık uygulamak için ETag değeri.
farmId	string	İlişkili Grup kimliği.
fieldId	string	İlişkili Alanın kimliği.
geometry	GeoJsonObject: MultiPolygon Point Polygon	GeoJSON (Daha fazla ayrıntı için: https://geojson.org/). Not: Koordinatlar [Boylam, Enlem] biçiminde beklenir.
id	string	Benzersiz kaynak kimliği.
modifiedBy	string	Kullanıcı/kiracı kimliği tarafından değiştirildi.
modifiedDateTime	string	Kaynağın en son değiştirildiği tarih-saat, örnek biçim: yyyy-MM-ddTHH:mm:ssZ.
name	string	Kaynağı tanımlamak için ad.
partyId	string	Parti Kimliği.
properties		Kaynağa ait anahtar değer çiftleri koleksiyonu. Her çiftin anahtarı 50 karakterden büyük olmamalıdır ve 150 karakterden büyük bir değere sahip olmamalıdır. Not: Bir kaynak için en fazla 25 anahtar değer çifti sağlanabilir ve yalnızca dize, sayı ve tarih saat (yyyy-MM-ddTHH:mm:ssZ) değerleri desteklenir.
seasonId	string	Ait olduğu mevsimin kimliği.
source	string	Kaynağın kaynağı.
status	string	Kaynağın durumu.