Chemical Products - List

Referenz

Dienst:: Azure Data Manager for Agriculture

API-Version:: 2023-11-01-preview

Gibt eine paginierte Liste chemischer Produktressourcen zurück.

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

Mit optionalen Parametern:

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

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string uri	Der Hostname des Namespace, z. B. admaInstanceName.farmbeats.azure.net
api-version	query	True	string	Die angeforderte API-Version
activeIngredients	query		string[]	ActiveIngredients von chemischen Produkten.
brands	query		string[]	Marken von chemischen Produkten.
companyNames	query		string[]	Firmennamen von chemischen Produkten.
cropIds	query		string[]	CropIds von chemischen Produkten.
datasetIds	query		string[]	Referenzdataset-ID des chemischen Produkts.
formulation	query		string[]	Formulierung des chemischen Produkts.
ids	query		string[]	Ids der Ressource.
locations	query		string[]	Standorte chemischer Produkte.
maxCreatedDateTime	query		string date-time	Maximales Erstellungsdatum der Ressource (inklusive).
maxLastModifiedDateTime	query		string date-time	Maximales Datum der letzten Änderung der Ressource (einschließlich).
maxPageSize	query		integer int32	Maximale Anzahl der benötigten Elemente (inklusive). Minimum = 10, Maximum = 1000, Standardwert = 50.
maxReEntryInterval	query		integer int32	Max ReEntryInterval von chemischen Produkten.
minCreatedDateTime	query		string date-time	Mindesterstellungsdatum der Ressource (inklusive).
minLastModifiedDateTime	query		string date-time	Mindestdatum der letzten Änderung der Ressource (einschließlich).
minReEntryInterval	query		integer int32	Min ReEntryInterval von chemischen Produkten.
names	query		string[]	Namen der Ressource.
products	query		string[]	Produkte aus chemischen Produkten.
propertyFilters	query		string[]	Filtert nach Schlüssel-Wert-Paaren innerhalb des Properties-Objekts. Beispiel: "{testKey} eq {testValue}".
referenceRecordIds	query		string[]	Referenzdatensatz-ID des chemischen Produkts.
registrationNumber	query		string[]	RegistrierungNummer des chemischen Produkts.
skipToken	query		string	Überspringen Sie das Token, um den nächsten Satz von Ergebnissen abzurufen.
specificGravity	query		string[]	Spezifische Schwere des chemischen Produkts.
states	query		string[]	Zustände des chemischen Erzeugnisses.
statuses	query		string[]	Status der Ressource.
types	query		string[]	Arten von chemischen Produkten.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Authorization	True	string	Geben Sie ein gültiges Bearertoken für autorisierte API-Aufrufe an. Beachten Sie, dass Sie möglicherweise Ihren Browsercache löschen müssen, wenn Sie zuvor nicht authentifizierte Aufrufe ausprobiert haben.

Antworten

Name	Typ	Beschreibung
200 OK	ChemicalProductListResponse	Erfolg
Other Status Codes	ErrorResponse	Fehler Header x-ms-error-code: string

Name

Typ

Beschreibung

200 OK

ChemicalProductListResponse

Erfolg

Other Status Codes

ErrorResponse

Fehler

Header

x-ms-error-code: string

Sicherheit

Authorization

Geben Sie ein gültiges Bearertoken für autorisierte API-Aufrufe an. Beachten Sie, dass Sie möglicherweise Ihren Browsercache löschen müssen, wenn Sie zuvor nicht authentifizierte Aufrufe ausprobiert haben.

Typ: apiKey
In: header

Beispiele

ChemicalProducts_List

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 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"
}

Definitionen

Name	Beschreibung
ChemicalProduct	Schema der ChemicalProduct-Ressource.
ChemicalProductListResponse	Die ausgelagerte Antwort enthält eine Liste der angeforderten Objekte und ein skipToken, um den nächsten Satz von Ergebnissen abzurufen.
Company	Firmen-/Herstellerdetails.
Error	Ein Fehler des Azure AgPlatform-Diensts.
ErrorResponse	Eine Fehlerantwort des Azure AgPlatform-Diensts. Weitere Informationen finden Sie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses unter ErrorResponse-Referenzdokument.
InnerError	Innerer Fehler, der eine Fehlerliste enthält. Weitere Informationen finden Sie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object unter InnerError-Referenzdokument.
Reference	Verweis auf einen Datasetdatensatz.

ChemicalProduct

Schema der ChemicalProduct-Ressource.

Name	Typ	Beschreibung
activeIngredients	string[]	Aktive Chemikalien in der Formulierung.
brand	string	Handelsmarke des chemischen Produkts.
company	Company	Firmen-/Herstellerdetails.
createdBy	string	Erstellt von Benutzer-/Mandanten-ID.
createdDateTime	string	Datum und Uhrzeit der Erstellung der Ressource, Beispielformat: jjjj-MM-ttTHH:mm:ssZ.
cropIds	string[]	Die Ids der Pflanzen, die dem chemischen Produkt zugeordnet sind. Hinweis: Einem cropProduct können maximal 25 Kulturen zugeordnet werden.
description	string	Textbeschreibung der Ressource.
eTag	string	Der ETag-Wert, um eine optimistische Parallelität zu implementieren.
formulation	string	Formulierungsbeschreibung. Prozentsatz oder andere Einheit von N, P, K, CA, MG, S, FE, MN, ZN, CU, B, MO, CL (basierend auf der Quelle können die verfügbaren chemischen Elemente variieren, aber dies ist eine typische Liste).
id	string	Eindeutige Ressourcen-ID.
location	string	Bereich, in dem die Chemikalie verwendet wird. Dies ist aus Compliancesicht wichtig.
modifiedBy	string	Geändert durch Benutzer-/Mandanten-ID.
modifiedDateTime	string	Datum und Uhrzeit der letzten Änderung der Ressource, Beispielformat: jjjj-MM-ttTHH:mm:ssZ.
name	string	Der Name zur Identifizierung der Ressource.
product	string	Handelsproduktname des chemischen Produkts.
properties		Eine Sammlung von Schlüsselwertpaaren, die zur Ressource gehören. Jedes Paar darf keinen Schlüssel größer als 50 Zeichen haben und darf keinen Wert größer als 150 Zeichen haben. Hinweis: Für eine Ressource können maximal 25 Schlüsselwertpaare bereitgestellt werden, und es werden nur Zeichenfolgen-, Zahlen- und Datetime-Werte (JJJJ-MM-ddTHH:mm:ssZ) unterstützt.
reEntryInterval	integer	Die Anzahl der Tage, nach denen eine Person das Feld besuchen kann, nachdem das chemische Produkt angewendet wurde.
reference	Reference	Verweis auf einen Datasetdatensatz.
registrationNumber	string	Registrierungsnummer der Chemikalie. Dies kann je nach Geografie variieren.
source	string	Quelle der Ressource.
specificGravity	string	Spezifische Schwerkraftdetails.
state	string	Liquid/non Liquid.
status	string	Status der Ressource.
type	string	Herbizid, Additiv, Insektizide, Düngemittel.

ChemicalProductListResponse

Die ausgelagerte Antwort enthält eine Liste der angeforderten Objekte und ein skipToken, um den nächsten Satz von Ergebnissen abzurufen.

Name	Typ	Beschreibung
nextLink	string	Fortsetzungslink (absoluter URI) auf die nächste Seite mit Ergebnissen in der Liste
skipToken	string	Token, das beim Abrufen der nächsten Seite verwendet wird. Wenn null, gibt es keine zusätzlichen Seiten.
value	ChemicalProduct[]	Liste der angeforderten Objekte.

Company

Firmen-/Herstellerdetails.

Name	Typ	Beschreibung
description	string	Beschreibung des Fertigungsunternehmens.
name	string	Name des Fertigungsunternehmens.
registrationNumber	string	Registrierungsnummer des Unternehmens.

Error

Ein Fehler des Azure AgPlatform-Diensts.

Name	Typ	Beschreibung
code	string	Vom Server definierte Gruppe von Fehlercodes.
details	Error[]	Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	InnerError	Innerer Fehler, der eine Fehlerliste enthält. Weitere Informationen finden Sie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object unter InnerError-Referenzdokument.
message	string	Lesbare Darstellung des Fehlers.
target	string	Ziel des Fehlers.

ErrorResponse

Eine Fehlerantwort des Azure AgPlatform-Diensts. Weitere Informationen finden Sie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses unter ErrorResponse-Referenzdokument.

Name	Typ	Beschreibung
error	Error	Ein Fehler des Azure AgPlatform-Diensts.
traceId	string	Eindeutige Ablaufverfolgungs-ID.

InnerError

Innerer Fehler, der eine Fehlerliste enthält. Weitere Informationen finden Sie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object unter InnerError-Referenzdokument.

Name	Typ	Beschreibung
code	string	Spezifischer Fehlercode als vom enthaltenden Fehler bereitgestellt wurde.
innererror	InnerError	Innerer Fehler, der eine Fehlerliste enthält. Weitere Informationen finden Sie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object unter InnerError-Referenzdokument.

Reference

Verweis auf einen Datasetdatensatz.

Name	Typ	Beschreibung
datasetId	string	Dataset-ID.
recordId	string	Datensatz-ID.

Freigeben über

Chemical Products - List

URI-Parameter

Anforderungsheader

Antworten

Sicherheit

Authorization

Beispiele

ChemicalProducts_List

Beispielanforderung

Beispiel für eine Antwort

Definitionen

ChemicalProduct

ChemicalProductListResponse

Company

Error

ErrorResponse

InnerError

Reference

Zusätzliche Ressourcen