Chemical Products - List

Usługa:: Azure Data Manager for Agriculture

Wersja interfejsu API:: 2023-11-01-preview

Zwraca listę podzielonych na strony zasobów produktów chemicznych.

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

Z parametrami opcjonalnymi:

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 identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string (uri)	Nazwa hosta przestrzeni nazw, np. admaInstanceName.farmbeats.azure.net
api-version	query	True	string	Żądana wersja interfejsu API
activeIngredients	query		string[]	Substancje aktywne produktu chemicznego.
brands	query		string[]	Marki produktów chemicznych.
companyNames	query		string[]	Nazwy firmy produktu chemicznego.
cropIds	query		string[]	CropIds produktu chemicznego.
datasetIds	query		string[]	Identyfikator zestawu danych referencyjnych produktu chemicznego.
formulation	query		string[]	Formuła produktu chemicznego.
ids	query		string[]	Identyfikatory zasobu.
locations	query		string[]	Lokalizacje produktu chemicznego.
maxCreatedDateTime	query		string (date-time)	Maksymalna data utworzenia zasobu (włącznie).
maxLastModifiedDateTime	query		string (date-time)	Maksymalna data ostatniej modyfikacji zasobu (włącznie).
maxPageSize	query		integer (int32) minimum: 10 maximum: 1000	Maksymalna liczba potrzebnych elementów (włącznie). Minimum = 10, Maksimum = 1000, Wartość domyślna = 50.
maxReEntryInterval	query		integer (int32)	Max ReEntryInterval produktu chemicznego.
minCreatedDateTime	query		string (date-time)	Minimalna data utworzenia zasobu (włącznie).
minLastModifiedDateTime	query		string (date-time)	Minimalna data ostatniej modyfikacji zasobu (włącznie).
minReEntryInterval	query		integer (int32)	Min ReEntryInterval produktu chemicznego.
names	query		string[]	Nazwy zasobu.
products	query		string[]	Produkty produktu chemicznego.
propertyFilters	query		string[]	Filtry par klucz-wartość w obiekcie Properties. Np. "{testKey} eq {testValue}".
referenceRecordIds	query		string[]	Identyfikator rekordu referencyjnego produktu chemicznego.
registrationNumber	query		string[]	RegistrationNumber produktu chemicznego.
skipToken	query		string	Pomiń token w celu uzyskania następnego zestawu wyników.
specificGravity	query		string[]	SpecyfikaGrawitacji produktu chemicznego.
states	query		string[]	Stany produktu chemicznego.
statuses	query		string[]	Stan zasobu.
types	query		string[]	Typy produktów chemicznych.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
Authorization	True	string	Podaj prawidłowy token elementu nośnego dla autoryzowanych wywołań interfejsu API. Pamiętaj, że może być konieczne wyczyszczenie pamięci podręcznej przeglądarki, jeśli wcześniej próbowano wykonać nieuwierzytelnione wywołania.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ChemicalProductListResponse	Powodzenie
Other Status Codes	ErrorResponse	Błąd Nagłówki x-ms-error-code: string

Nazwa

Typ

Opis

200 OK

ChemicalProductListResponse

Powodzenie

Other Status Codes

ErrorResponse

Błąd

Nagłówki

x-ms-error-code: string

Zabezpieczenia

Authorization

Podaj prawidłowy token elementu nośnego dla autoryzowanych wywołań interfejsu API. Pamiętaj, że może być konieczne wyczyszczenie pamięci podręcznej przeglądarki, jeśli wcześniej próbowano wykonać nieuwierzytelnione wywołania.

Typ: apiKey
W: header

Przykłady

ChemicalProducts_List

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 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"
}

Definicje

Nazwa	Opis
ChemicalProduct	Schemat zasobu ChemicalProduct.
ChemicalProductListResponse	Odpowiedź stronicowana zawiera listę żądanych obiektów i skipToken w celu uzyskania następnego zestawu wyników.
Company	Szczegóły firmy/producenta.
Error	Błąd usługi Azure AgPlatform.
ErrorResponse	Odpowiedź na błąd z usługi Azure AgPlatform. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses, aby zapoznać się z dokumentem referencyjnym ErrorResponse.
InnerError	Wewnętrzny błąd zawierający listę błędów. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object, aby zapoznać się z dokumentem referencyjnym InnerError.
Reference	Odwołanie do rekordu zestawu danych.

ChemicalProduct

Objekt

Schemat zasobu ChemicalProduct.

Nazwa	Typ	Opis
activeIngredients	string[]	Substancje chemiczne aktywne w formule.
brand	string	Komercyjna marka produktu chemicznego.
company	Company	Szczegóły firmy/producenta.
createdBy	string	Utworzony przez identyfikator użytkownika/dzierżawy.
createdDateTime	string (date-time)	Data i godzina utworzenia zasobu, przykładowy format: rrrr-MM-ddTHH:mm:ssZ.
cropIds	string[]	Identyfikatory upraw skojarzonych z produktem chemicznym. Uwaga: z uprawą można skojarzyć maksymalnie 25 upraw.
description	string minLength: 0 maxLength: 500	Tekstowy opis zasobu.
eTag	string	Wartość ETag w celu zaimplementowania optymistycznej współbieżności.
formulation	string	Opis formuły. Procent lub inna jednostka N, P, K, CA, MG, S, FE, MN, ZN, CU, B, MO, CL (na podstawie źródła dostępne elementy chemiczne mogą się różnić, ale jest to typowa lista).
id	string	Unikatowy identyfikator zasobu.
location	string	Obszar, w którym stosuje się substancję chemiczną. Jest to ważne z punktu widzenia zgodności.
modifiedBy	string	Zmodyfikowany przez identyfikator użytkownika/dzierżawy.
modifiedDateTime	string (date-time)	Data i godzina ostatniej modyfikacji zasobu, format próbki: rrrr-MM-ddTHH:mm:ssZ.
name	string minLength: 0 maxLength: 100	Nazwa identyfikującego zasób.
product	string	Komercyjna nazwa produktu chemicznego.
properties		Kolekcja par klucz-wartość, która należy do zasobu. Każda para nie może mieć klucza większego niż 50 znaków i nie może mieć wartości większej niż 150 znaków. Uwaga: Dla zasobu można podać maksymalnie 25 par wartości klucza, a obsługiwane są tylko wartości ciągu, liczb i daty/godziny (rrrr-MM-ddTHH:mm:ssZ).
reEntryInterval	integer (int32)	Liczba dni, po których osoba może odwiedzić pole po zastosowaniu produktu chemicznego.
reference	Reference	Odwołanie do rekordu zestawu danych.
registrationNumber	string	Numer rejestracyjny substancji chemicznej. Może się to różnić w zależności od lokalizacji geograficznej.
source	string minLength: 2 maxLength: 100	Źródło zasobu.
specificGravity	string	Szczegóły specyficznej grawitacji.
state	string	Płynny/niepłynny.
status	string minLength: 0 maxLength: 100	Stan zasobu.
type	string	Herbicyd, addytywne, środki owadobójcze, nawozy.

ChemicalProductListResponse

Objekt

Odpowiedź stronicowana zawiera listę żądanych obiektów i skipToken w celu uzyskania następnego zestawu wyników.

Nazwa	Typ	Opis
nextLink	string	Link kontynuacji (bezwzględny identyfikator URI) do następnej strony wyników na liście.
skipToken	string	Token używany podczas pobierania następnej strony. Jeśli wartość null, nie ma żadnych dodatkowych stron.
value	ChemicalProduct[]	Lista żądanych obiektów.

Company

Objekt

Szczegóły firmy/producenta.

Nazwa	Typ	Opis
description	string	Opis firmy produkcyjnej.
name	string	Nazwa firmy produkcyjnej.
registrationNumber	string	Numer rejestracyjny firmy.

Error

Objekt

Błąd usługi Azure AgPlatform.

Nazwa	Typ	Opis
code	string minLength: 1	Zdefiniowany przez serwer zestaw kodów błędów.
details	Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	InnerError	Wewnętrzny błąd zawierający listę błędów. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object, aby zapoznać się z dokumentem referencyjnym InnerError.
message	string minLength: 1	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd z usługi Azure AgPlatform. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses, aby zapoznać się z dokumentem referencyjnym ErrorResponse.

Nazwa	Typ	Opis
error	Error	Błąd usługi Azure AgPlatform.
traceId	string	Unikatowy identyfikator śledzenia.

InnerError

Objekt

Wewnętrzny błąd zawierający listę błędów. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object, aby zapoznać się z dokumentem referencyjnym InnerError.

Nazwa	Typ	Opis
code	string	Określony kod błędu niż został dostarczony przez błąd zawierający.
innererror	InnerError	Wewnętrzny błąd zawierający listę błędów. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object, aby zapoznać się z dokumentem referencyjnym InnerError.

Reference

Objekt

Odwołanie do rekordu zestawu danych.

Nazwa	Typ	Opis
datasetId	string minLength: 0 maxLength: 100	Identyfikator zestawu danych.
recordId	string minLength: 0 maxLength: 100	Identyfikator rekordu.