Sdílet prostřednictvím


Chemical Products - List

Vrátí stránkovaný seznam prostředků chemického produktu.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
endpoint
path True

string

uri

Název hostitele oboru názvů, například admaInstanceName.farmbeats.azure.net

api-version
query True

string

Požadovaná verze rozhraní API

activeIngredients
query

string[]

Aktivníprodukty chemického přípravku.

brands
query

string[]

Značky chemických produktů.

companyNames
query

string[]

Názvy společnosti chemického výrobku.

cropIds
query

string[]

CropId chemického produktu.

datasetIds
query

string[]

Id referenční datové sady chemického produktu

formulation
query

string[]

Složení chemického přípravku.

ids
query

string[]

ID prostředku.

locations
query

string[]

Umístění chemického výrobku.

maxCreatedDateTime
query

string

date-time

Maximální datum vytvoření prostředku (včetně).

maxLastModifiedDateTime
query

string

date-time

Maximální datum poslední změny prostředku (včetně).

maxPageSize
query

integer

int32

Maximální počet potřebných položek (včetně). Minimum = 10, Maximum = 1000, Výchozí hodnota = 50.

maxReEntryInterval
query

integer

int32

Max ReEntryInterval chemického produktu.

minCreatedDateTime
query

string

date-time

Minimální datum vytvoření prostředku (včetně).

minLastModifiedDateTime
query

string

date-time

Minimální datum poslední změny prostředku (včetně).

minReEntryInterval
query

integer

int32

Min ReEntryInterval chemického přípravku.

names
query

string[]

Názvy prostředku.

products
query

string[]

Výrobky chemického výrobku.

propertyFilters
query

string[]

Filtruje páry klíč-hodnota v objektu Properties. např. {testKey} eq {testValue}.

referenceRecordIds
query

string[]

ID referenčního záznamu chemického výrobku.

registrationNumber
query

string[]

RegistrationNumber chemického výrobku.

skipToken
query

string

Přeskočení tokenu pro získání další sady výsledků

specificGravity
query

string[]

SpecificGravity chemického přípravku.

states
query

string[]

Stavy chemického přípravku.

statuses
query

string[]

Stavy prostředku.

types
query

string[]

Typy chemických produktů.

Hlavička požadavku

Name Vyžadováno Typ Description
Authorization True

string

Zadejte platný nosný token pro autorizovaná volání rozhraní API. Upozorňujeme, že pokud jste se předtím pokusili o neověřené volání, možná budete muset vymazat mezipaměť prohlížeče.

Odpovědi

Name Typ Description
200 OK

ChemicalProductListResponse

Success

Other Status Codes

ErrorResponse

Chybová

Hlavičky

x-ms-error-code: string

Zabezpečení

Authorization

Zadejte platný nosný token pro autorizovaná volání rozhraní API. Upozorňujeme, že pokud jste se předtím pokusili o neověřené volání, možná budete muset vymazat mezipaměť prohlížeče.

Typ: apiKey
V: header

Příklady

ChemicalProducts_List

Ukázkový požadavek

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

Ukázková odpověď

{
  "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"
}

Definice

Name Description
ChemicalProduct

Schéma prostředku ChemicalProduct

ChemicalProductListResponse

Stránkovaná odpověď obsahuje seznam požadovaných objektů a skipToken pro získání další sady výsledků.

Company

Údaje o společnosti nebo výrobci.

Error

Chyba ze služby Azure AgPlatform.

ErrorResponse

Chybová odpověď ze služby Azure AgPlatform. Viz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses referenční dokument ErrorResponse.

InnerError

Vnitřní chyba obsahující seznam chyb. Viz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object referenční dokument InnerError.

Reference

Odkaz na záznam datové sady.

ChemicalProduct

Schéma prostředku ChemicalProduct

Name Typ Description
activeIngredients

string[]

Aktivní chemické látky v přípravku.

brand

string

Komerční značka chemického výrobku.

company

Company

Údaje o společnosti nebo výrobci.

createdBy

string

Vytvořeno podle ID uživatele nebo tenanta.

createdDateTime

string

Datum a čas vytvoření prostředku, ukázkový formát: yyyy-MM-ddTHH:mm:ssZ.

cropIds

string[]

Id plodin spojených s chemickým produktem. Poznámka: K plodiněProduct může být přidruženo maximálně 25 plodin.

description

string

Textový popis prostředku.

eTag

string

Hodnota ETag pro implementaci optimistické souběžnosti

formulation

string

Popis formulace. Procento nebo jiná jednotka N, P, K, CA, MG, S, FE, MN, ZN, CU, B, MO, CL (v závislosti na zdroji se dostupné chemické prvky mohou lišit, ale toto je typický seznam).

id

string

Jedinečné ID prostředku.

location

string

Oblast, kde se chemická látka používá. To je důležité z hlediska dodržování předpisů.

modifiedBy

string

Upraveno podle ID uživatele nebo tenanta.

modifiedDateTime

string

Datum a čas poslední změny prostředku, ukázkový formát: yyyy-MM-ddTHH:mm:ssZ.

name

string

Název pro identifikaci prostředku

product

string

Obchodní název chemického výrobku.

properties

Kolekce párů hodnot klíčů, které patří do prostředku. Každý pár nesmí mít klíč větší než 50 znaků a nesmí mít hodnotu větší než 150 znaků. Poznámka: Pro prostředek je možné zadat maximálně 25 párů hodnot klíčů a podporují se pouze hodnoty string, numeral a datetime (yyyy-MM-ddTHH:mm:ssZ).

reEntryInterval

integer

Počet dnů, po kterých může osoba navštívit pole po aplikaci chemického přípravku.

reference

Reference

Odkaz na záznam datové sady.

registrationNumber

string

Registrační číslo chemické látky. To se může lišit podle zeměpisné oblasti.

source

string

Zdroj prostředku.

specificGravity

string

Specifické podrobnosti o závažnosti.

state

string

Liquid/non Liquid.

status

string

Stav prostředku.

type

string

Insekticidy, přísady, insekticidy, hnojiva.

ChemicalProductListResponse

Stránkovaná odpověď obsahuje seznam požadovaných objektů a skipToken pro získání další sady výsledků.

Name Typ Description
nextLink

string

Odkaz na pokračování (absolutní identifikátor URI) na další stránku výsledků v seznamu.

skipToken

string

Token použitý při načítání další stránky. Pokud je hodnota null, nejsou k dispozici žádné další stránky.

value

ChemicalProduct[]

Seznam požadovaných objektů

Company

Údaje o společnosti nebo výrobci.

Name Typ Description
description

string

Popis výrobní společnosti.

name

string

Název výrobní společnosti.

registrationNumber

string

Registrační číslo společnosti.

Error

Chyba ze služby Azure AgPlatform.

Name Typ Description
code

string

Sada kódů chyb definovaná serverem.

details

Error[]

Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.

innererror

InnerError

Vnitřní chyba obsahující seznam chyb. Viz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object referenční dokument InnerError.

message

string

Znázornění chyby čitelné pro člověka

target

string

Cíl chyby.

ErrorResponse

Chybová odpověď ze služby Azure AgPlatform. Viz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses referenční dokument ErrorResponse.

Name Typ Description
error

Error

Chyba ze služby Azure AgPlatform.

traceId

string

Jedinečné ID trasování.

InnerError

Vnitřní chyba obsahující seznam chyb. Viz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object referenční dokument InnerError.

Name Typ Description
code

string

Konkrétní kód chyby, než byl poskytnut chybou obsahující chybu.

innererror

InnerError

Vnitřní chyba obsahující seznam chyb. Viz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object referenční dokument InnerError.

Reference

Odkaz na záznam datové sady.

Name Typ Description
datasetId

string

ID datové sady.

recordId

string

ID záznamu.