Chemical Products - List

Tjänst:

Azure Data Manager for Agriculture

API-version:

2023-11-01-preview

Returnerar en sidnumrerad lista över kemiska produktresurser.

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

Med valfria parametrar:

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-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string (uri)	Namnområdets värdnamn, t.ex. admaInstanceName.farmbeats.azure.net
api-version	query	True	string	Den begärda API-versionen
activeIngredients	query		string[]	ActiveIngredients av kemisk produkt.
brands	query		string[]	Varumärken av kemiska produkter.
companyNames	query		string[]	Företagsnamn på kemiska produkter.
cropIds	query		string[]	CropIds av kemisk produkt.
datasetIds	query		string[]	Referensdatamängds-ID för kemiska produkter.
formulation	query		string[]	Formulering av kemisk produkt.
ids	query		string[]	ID:t för resursen.
locations	query		string[]	Platser för kemiska produkter.
maxCreatedDateTime	query		string (date-time)	Maximalt skapandedatum för resurs (inklusive).
maxLastModifiedDateTime	query		string (date-time)	Maximalt senast ändrat datum för resursen (inklusive).
maxPageSize	query		integer (int32) minimum: 10 maximum: 1000	Maximalt antal objekt som behövs (inklusive). Minimum = 10, Maximum = 1000, Standardvärde = 50.
maxReEntryInterval	query		integer (int32)	Max ReEntryInterval av kemisk produkt.
minCreatedDateTime	query		string (date-time)	Minsta skapandedatum för resursen (inklusive).
minLastModifiedDateTime	query		string (date-time)	Minsta senaste ändringsdatum för resursen (inklusive).
minReEntryInterval	query		integer (int32)	Min ReEntryInterval av kemisk produkt.
names	query		string[]	Namn på resursen.
products	query		string[]	Produkter av kemiska produkter.
propertyFilters	query		string[]	Filtrerar på nyckel/värde-par i objektet Egenskaper. T.ex. "{testKey} eq {testValue}".
referenceRecordIds	query		string[]	Referenspost-ID för kemiska produkter.
registrationNumber	query		string[]	RegistreringsNummer för kemisk produkt.
skipToken	query		string	Hoppa över token för att hämta nästa uppsättning resultat.
specificGravity	query		string[]	SpecificGravity av kemisk produkt.
states	query		string[]	tillstånd för kemiska produkter.
statuses	query		string[]	Status för resursen.
types	query		string[]	Typer av kemiska produkter.

Begärandehuvud

Name	Obligatorisk	Typ	Description
Authorization	True	string	Ange en giltig ägartoken för auktoriserade API-anrop. Observera att du kan behöva rensa webbläsarens cacheminne om du har provat oautentiserade anrop tidigare.

Svar

Name	Typ	Description
200 OK	ChemicalProductListResponse	Framgång
Other Status Codes	ErrorResponse	Fel Sidhuvuden x-ms-error-code: string

Säkerhet

Authorization

Ange en giltig ägartoken för auktoriserade API-anrop. Observera att du kan behöva rensa webbläsarens cacheminne om du har provat oautentiserade anrop tidigare.

Typ: apiKey
I: header

Exempel

ChemicalProducts_List

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:

200

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

Definitioner

Name	Description
ChemicalProduct	Schema för ChemicalProduct-resursen.
ChemicalProductListResponse	Sidsidigt svar innehåller en lista över begärda objekt och en skipToken för att hämta nästa uppsättning resultat.
Company	Företagets/tillverkarens information.
Error	Ett fel från Azure AgPlatform-tjänsten.
ErrorResponse	Ett felsvar från Azure AgPlatform-tjänsten. Se https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses för ErrorResponse-referensdokumentet.
InnerError	Inre fel som innehåller en lista över fel. Se referensdokumentet https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object för InnerError.
Reference	Referens till en datamängdspost.

ChemicalProduct

Objekt

Schema för ChemicalProduct-resursen.

Name	Typ	Description
activeIngredients	string[]	Aktiva kemikalier i formuleringen.
brand	string	Den kemiska produktens kommersiella varumärke.
company	Company	Företagets/tillverkarens information.
createdBy	string	Skapad av användar-/klient-ID.
createdDateTime	string (date-time)	Datum-tid när resursen skapades, exempelformat: åååå-MM-ddTHH:mm:ssZ.
cropIds	string[]	ID:erna för de grödor som är associerade med den kemiska produkten. Obs! Högst 25 grödor kan associeras med en cropProduct.
description	string minLength: 0 maxLength: 500	Textbeskrivning av resursen.
eTag	string	ETag-värdet för att implementera optimistisk samtidighet.
formulation	string	Beskrivning av formulering. Procentandel eller annan enhet av N, P, K, CA, MG, S, FE, MN, ZN, CU, B, MO, CL (baserat på källan kan de tillgängliga kemiska elementen variera, men detta är en typisk lista).
id	string	Unikt resurs-ID.
location	string	Område där kemikalien används. Detta är viktigt ur ett efterlevnadsperspektiv.
modifiedBy	string	Ändrat av användar-/klient-ID.
modifiedDateTime	string (date-time)	Datum-tid när resursen senast ändrades, exempelformat: åååå-MM-ddTHH:mm:ssZ.
name	string minLength: 0 maxLength: 100	Namn för att identifiera resursen.
product	string	Den kemiska produktens kommersiella produktnamn.
properties		En samling nyckelvärdepar som tillhör resursen. Varje par får inte ha en nyckel som är större än 50 tecken och får inte ha ett värde som är större än 150 tecken. Obs! Högst 25 nyckelvärdepar kan anges för en resurs och endast värden för sträng, siffror och datetime (åååå-MM-ddTHH:mm:ssZ) stöds.
reEntryInterval	integer (int32)	Antalet dagar efter vilken en person kan besöka fältet efter att den kemiska produkten har tillämpats.
reference	Reference	Referens till en datamängdspost.
registrationNumber	string	Registreringsnummer för kemikalien. Detta kan variera beroende på geografi.
source	string minLength: 2 maxLength: 100	Resursens källa.
specificGravity	string	Specifika detaljer om gravitationen.
state	string	Flytande/ej flytande.
status	string minLength: 0 maxLength: 100	Status för resursen.
type	string	Herbicid, Additiv, Insekticider, Gödningsmedel.

ChemicalProductListResponse

Objekt

Sidsidigt svar innehåller en lista över begärda objekt och en skipToken för att hämta nästa uppsättning resultat.

Name	Typ	Description
nextLink	string	Fortsättningslänk (absolut URI) till nästa sida med resultat i listan.
skipToken	string	Token som används för att hämta nästa sida. Om värdet är null finns det inga ytterligare sidor.
value	ChemicalProduct[]	Lista över begärda objekt.

Company

Objekt

Företagets/tillverkarens information.

Name	Typ	Description
description	string	Beskrivning av tillverkningsföretaget.
name	string	Namnet på tillverkningsföretaget.
registrationNumber	string	Företagets registreringsnummer.

Error

Objekt

Ett fel från Azure AgPlatform-tjänsten.

Name	Typ	Description
code	string minLength: 1	Serverdefinierad uppsättning felkoder.
details	Error[]	Matris med information om specifika fel som ledde till det rapporterade felet.
innererror	InnerError	Inre fel som innehåller en lista över fel. Se referensdokumentet https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object för InnerError.
message	string minLength: 1	Mänsklig läsbar representation av felet.
target	string	Målet för felet.

ErrorResponse

Objekt

Ett felsvar från Azure AgPlatform-tjänsten. Se https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses för ErrorResponse-referensdokumentet.

Name	Typ	Description
error	Error	Ett fel från Azure AgPlatform-tjänsten.
traceId	string	Unikt spårnings-ID.

InnerError

Objekt

Inre fel som innehåller en lista över fel. Se referensdokumentet https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object för InnerError.

Name	Typ	Description
code	string	Specifik felkod än vad som angavs av det innehållande felet.
innererror	InnerError	Inre fel som innehåller en lista över fel. Se referensdokumentet https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object för InnerError.

Reference

Objekt

Referens till en datamängdspost.

Name	Typ	Description
datasetId	string minLength: 0 maxLength: 100	Datamängds-ID.
recordId	string minLength: 0 maxLength: 100	Spela in ID.