Aracılığıyla paylaş


Chemical Products - List

Kimyasal ürün kaynaklarının sayfalandırılmış listesini döndürür.

GET {endpoint}/chemical-products?api-version=2023-11-01-preview
GET {endpoint}/chemical-products?cropIds={cropIds}&brands={brands}&products={products}&types={types}&states={states}&activeIngredients={activeIngredients}&specificGravity={specificGravity}&formulation={formulation}&registrationNumber={registrationNumber}&minReEntryInterval={minReEntryInterval}&maxReEntryInterval={maxReEntryInterval}&locations={locations}&companyNames={companyNames}&datasetIds={datasetIds}&referenceRecordIds={referenceRecordIds}&ids={ids}&names={names}&propertyFilters={propertyFilters}&statuses={statuses}&minCreatedDateTime={minCreatedDateTime}&maxCreatedDateTime={maxCreatedDateTime}&minLastModifiedDateTime={minLastModifiedDateTime}&maxLastModifiedDateTime={maxLastModifiedDateTime}&maxPageSize={maxPageSize}&skipToken={skipToken}&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

api-version
query True

string

İstenen API sürümü

activeIngredients
query

string[]

Kimyasal ürünün AktifIngredients.

brands
query

string[]

Kimyasal ürün markaları.

companyNames
query

string[]

Kimyasal ürünün şirket adları.

cropIds
query

string[]

Kimyasal ürünün CropId'leri.

datasetIds
query

string[]

Kimyasal ürünün başvuru veri kümesi kimliği.

formulation
query

string[]

Kimyasal ürünün formülasyonu.

ids
query

string[]

Kaynağın kimlikleri.

locations
query

string[]

Kimyasal ürünün konumları.

maxCreatedDateTime
query

string

date-time

Kaynağın oluşturma tarihi üst sınırı (dahil).

maxLastModifiedDateTime
query

string

date-time

Kaynağın son değiştirme tarihi üst sınırı (dahil).

maxPageSize
query

integer

int32

Gereken en fazla öğe sayısı (dahil). Minimum = 10, Maksimum = 1000, Varsayılan değer = 50.

maxReEntryInterval
query

integer

int32

Kimyasal ürünün Max ReEntryInterval'ı.

minCreatedDateTime
query

string

date-time

Kaynağın en düşük oluşturma tarihi (dahil).

minLastModifiedDateTime
query

string

date-time

Kaynağın en son değiştirilme tarihi (dahil).

minReEntryInterval
query

integer

int32

Min ReEntryInterval kimyasal ürün.

names
query

string[]

Kaynağın adları.

products
query

string[]

Kimyasal ürün ürünleri.

propertyFilters
query

string[]

Özellikler nesnesi içindeki anahtar-değer çiftlerinde filtreler. Örneğin "{testKey} eq {testValue}".

referenceRecordIds
query

string[]

Kimyasal ürünün referans kayıt kimliği.

registrationNumber
query

string[]

Kimyasal ürünün Kayıt Numarası.

skipToken
query

string

Sonraki sonuç kümesini almak için belirteci atlayın.

specificGravity
query

string[]

Kimyasal ürünün özel Çekim.

states
query

string[]

Kimyasal ürün durumları.

statuses
query

string[]

Kaynağın durumları.

types
query

string[]

Kimyasal ürün türleri.

İstek Başlığı

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.

Yanıtlar

Name Tür Description
200 OK

ChemicalProductListResponse

Başarılı

Other Status Codes

ErrorResponse

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

ChemicalProducts_List

Örnek isteği

GET {endpoint}/chemical-products?api-version=2023-11-01-preview

Örnek yanıt

{
  "value": [
    {
      "id": "Chemical123",
      "cropIds": [
        "CropId"
      ],
      "reference": {
        "datasetId": "datasetId",
        "recordId": "recordId"
      },
      "brand": "Brand",
      "product": "AGTECH",
      "type": "Herbicide",
      "state": "Liquid",
      "activeIngredients": [
        "NO2"
      ],
      "specificGravity": "string",
      "formulation": "N, P, K",
      "company": {
        "name": "CompanyName",
        "description": "Agriculture Manufacturer",
        "registrationNumber": "1234"
      },
      "location": "US",
      "registrationNumber": "1234",
      "reEntryInterval": 5,
      "status": "Active",
      "source": "Manufacturer",
      "name": "Fertilizer1",
      "description": "string",
      "properties": {
        "key1": "value1",
        "key2": 123.45
      },
      "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"
    }
  ],
  "skipToken": "string",
  "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/chemical-products/{{chemicalProductId}}?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"
}

Tanımlar

Name Description
ChemicalProduct

ChemicalProduct kaynağının şeması.

ChemicalProductListResponse

Disk belleğine alınan yanıt, istenen nesnelerin listesini ve sonraki sonuç kümesini almak için bir skipToken içerir.

Company

Şirket/Üreticinin ayrıntıları.

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 .

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 .

Reference

Veri kümesi kaydına başvuru.

ChemicalProduct

ChemicalProduct kaynağının şeması.

Name Tür Description
activeIngredients

string[]

Formülasyondaki aktif kimyasallar.

brand

string

Kimyasal ürünün ticari markası.

company

Company

Şirket/Üreticinin ayrıntıları.

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.

cropIds

string[]

Kimyasal ürünle ilişkili mahsullerin kimlikleri. Not: Bir cropProduct ile en fazla 25 kırpma ilişkilendirilebilir.

description

string

Kaynağın metinsel açıklaması.

eTag

string

İyimser eşzamanlılık uygulamak için ETag değeri.

formulation

string

Formülasyon açıklaması. N, P, K, CA, MG, S, FE, MN, ZN, CU, B, MO, CL'nin yüzdesi veya diğer birimi (kaynağa bağlı olarak, kullanılabilir kimyasal elementler farklılık gösterebilir, ancak bu tipik bir listedir).

id

string

Benzersiz kaynak kimliği.

location

string

Kimyasalın kullanıldığı alan. Bu, uyumluluk açısından önemlidir.

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.

product

string

Kimyasal ürünün ticari ürün 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.

reEntryInterval

integer

Kimyasal ürün uygulandıktan sonra bir kişinin alanı ziyaret ettiği gün sayısı.

reference

Reference

Veri kümesi kaydına başvuru.

registrationNumber

string

Kimyasalın kayıt numarası. Bu, coğrafyaya göre farklılık gösterebilir.

source

string

Kaynağın kaynağı.

specificGravity

string

Belirli yerçekimi ayrıntıları.

state

string

Sıvı/Sıvı olmayan.

status

string

Kaynağın durumu.

type

string

Herbisit, Katkı Maddesi, İnsektisitler, Gübreler.

ChemicalProductListResponse

Disk belleğine alınan yanıt, istenen nesnelerin listesini ve sonraki sonuç kümesini almak için bir skipToken içerir.

Name Tür Description
nextLink

string

Listenin bir sonraki sonuç sayfasına devamlılık bağlantısı (mutlak URI).

skipToken

string

Sonraki sayfa alınırken kullanılan belirteç. Null ise, başka sayfa yoktur.

value

ChemicalProduct[]

İstenen nesnelerin listesi.

Company

Şirket/Üreticinin ayrıntıları.

Name Tür Description
description

string

Üretim Şirketi açıklaması.

name

string

Üretim şirketinin adı.

registrationNumber

string

Şirketin kayıt numarası.

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.

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 .

Reference

Veri kümesi kaydına başvuru.

Name Tür Description
datasetId

string

Veri kümesi kimliği.

recordId

string

Kayıt kimliği.