Chemical Products - List

Referentie

Service:: Azure Data Manager for Agriculture

API-versie:: 2023-11-01-preview

Retourneert een gepagineerde lijst met chemische productbronnen.

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

Met optionele parameters:

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

Name	In	Vereist	Type	Description
endpoint	path	True	string (uri)	De hostnaam van de naamruimte, bijvoorbeeld admaInstanceName.farmbeats.azure.net
api-version	query	True	string	De aangevraagde API-versie
activeIngredients	query		string[]	ActiveIngredients van chemisch product.
brands	query		string[]	Merken van chemisch product.
companyNames	query		string[]	Bedrijfsnamen van chemisch product.
cropIds	query		string[]	CropIds van chemisch product.
datasetIds	query		string[]	Referentiegegevensset-id van chemisch product.
formulation	query		string[]	Formulering van chemisch product.
ids	query		string[]	Id's van de resource.
locations	query		string[]	Locaties van chemisch product.
maxCreatedDateTime	query		string (date-time)	Maximale aanmaakdatum van resource (inclusief).
maxLastModifiedDateTime	query		string (date-time)	Maximale datum van laatste wijziging van resource (inclusief).
maxPageSize	query		integer (int32) minimum: 10 maximum: 1000	Maximum aantal benodigde items (inclusief). Minimum = 10, Maximum = 1000, Standaardwaarde = 50.
maxReEntryInterval	query		integer (int32)	Max ReEntryInterval van chemisch product.
minCreatedDateTime	query		string (date-time)	Minimale aanmaakdatum van resource (inclusief).
minLastModifiedDateTime	query		string (date-time)	Minimale datum van laatste wijziging van resource (inclusief).
minReEntryInterval	query		integer (int32)	Min ReEntryInterval van chemisch product.
names	query		string[]	Namen van de resource.
products	query		string[]	Producten van chemisch product.
propertyFilters	query		string[]	Filters op sleutel-waardeparen in het object Eigenschappen. bijvoorbeeld "{testKey} eq {testValue}".
referenceRecordIds	query		string[]	Referentierecord-id van chemisch product.
registrationNumber	query		string[]	Registratienummer van chemisch product.
skipToken	query		string	Sla het token over voor het ophalen van de volgende set resultaten.
specificGravity	query		string[]	SpecificGraviteit van chemisch product.
states	query		string[]	Toestanden van chemisch product.
statuses	query		string[]	Statussen van de resource.
types	query		string[]	Soorten chemisch product.

Aanvraagkoptekst

Name	Vereist	Type	Description
Authorization	True	string	Geef een geldig Bearer-token op voor geautoriseerde API-aanroepen. Houd er rekening mee dat u uw browsercache mogelijk moet wissen als u eerder niet-geverifieerde aanroepen hebt geprobeerd.

Antwoorden

Name	Type	Description
200 OK	ChemicalProductListResponse	Geslaagd
Other Status Codes	ErrorResponse	Fout Kopteksten x-ms-error-code: string

Name

Type

Description

200 OK

ChemicalProductListResponse

Geslaagd

Other Status Codes

ErrorResponse

Fout

Kopteksten

x-ms-error-code: string

Beveiliging

Authorization

Geef een geldig Bearer-token op voor geautoriseerde API-aanroepen. Houd er rekening mee dat u uw browsercache mogelijk moet wissen als u eerder niet-geverifieerde aanroepen hebt geprobeerd.

Type: apiKey
In: header

Voorbeelden

ChemicalProducts_List

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

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

Definities

Name	Description
ChemicalProduct	Schema van chemischeproductresource.
ChemicalProductListResponse	Gepaginad antwoord bevat een lijst met aangevraagde objecten en een skipToken om de volgende set resultaten op te halen.
Company	Bedrijfs-/fabrikantgegevens.
Error	Een fout van de Azure AgPlatform-service.
ErrorResponse	Een foutreactie van de Azure AgPlatform-service. Zie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses voor het referentiedocument ErrorResponse.
InnerError	Interne fout met een lijst met fouten. Zie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object voor innerError-referentiedocument.
Reference	Verwijzing naar een gegevenssetrecord.

ChemicalProduct

Object

Schema van chemischeproductresource.

Name	Type	Description
activeIngredients	string[]	Actieve chemicaliën in de formulering.
brand	string	Commercieel merk van het chemische product.
company	Company	Bedrijfs-/fabrikantgegevens.
createdBy	string	Gemaakt door gebruiker/tenant-id.
createdDateTime	string (date-time)	Datum en tijd waarop de resource is gemaakt, voorbeeldindeling: jjjj-MM-ddTHH:mm:ssZ.
cropIds	string[]	De id's van de gewassen die aan het chemische product zijn gekoppeld. Opmerking: Maximaal 25 gewassen kunnen worden gekoppeld aan een cropProduct.
description	string minLength: 0 maxLength: 500	Tekstbeschrijving van de resource.
eTag	string	De ETag-waarde voor het implementeren van optimistische gelijktijdigheid.
formulation	string	Formuleringsbeschrijving. Percentage of een andere eenheid van N, P, K, CA, MG, S, FE, MN, ZN, CU, B, MO, CL (gebaseerd op de bron, de beschikbare chemische elementen kunnen variëren, maar dit is een typische lijst).
id	string	Unieke resource-id.
location	string	Gebied waar de chemische stof wordt gebruikt. Dit is belangrijk vanuit het oogpunt van naleving.
modifiedBy	string	Gewijzigd door de gebruikers-/tenant-id.
modifiedDateTime	string (date-time)	Datum en tijd waarop de resource voor het laatst is gewijzigd, voorbeeldindeling: jjjj-MM-ddTHH:mm:ssZ.
name	string minLength: 0 maxLength: 100	Naam om de resource te identificeren.
product	string	Commerciële productnaam van het chemische product.
properties		Een verzameling sleutel-waardeparen die deel uitmaken van de resource. Elk paar mag geen sleutel van meer dan 50 tekens hebben en mag geen waarde van meer dan 150 tekens hebben. Opmerking: er kunnen maximaal 25 sleutelwaardeparen worden opgegeven voor een resource en alleen tekenreeks-, numerieke en datum/tijd-waarden (jjjj-MM-ddTHH:mm:ssZ) worden ondersteund.
reEntryInterval	integer (int32)	Het aantal dagen waarna een persoon het veld kan bezoeken nadat het chemische product is toegepast.
reference	Reference	Verwijzing naar een gegevenssetrecord.
registrationNumber	string	Registratienummer van de chemische stof. Dit kan variëren per geografie.
source	string minLength: 2 maxLength: 100	Bron van de resource.
specificGravity	string	Specifieke zwaartekrachtdetails.
state	string	Liquid/non Liquid.
status	string minLength: 0 maxLength: 100	Status van de resource.
type	string	Additieven, Insecticiden, Insecticiden, Meststoffen.

ChemicalProductListResponse

Object

Gepaginad antwoord bevat een lijst met aangevraagde objecten en een skipToken om de volgende set resultaten op te halen.

Name	Type	Description
nextLink	string	Vervolgkoppeling (absolute URI) naar de volgende pagina met resultaten in de lijst.
skipToken	string	Token dat wordt gebruikt bij het ophalen van de volgende pagina. Als null is, zijn er geen extra pagina's.
value	ChemicalProduct[]	Lijst met aangevraagde objecten.

Company

Object

Bedrijfs-/fabrikantgegevens.

Name	Type	Description
description	string	Beschrijving productiebedrijf.
name	string	Naam van het productiebedrijf.
registrationNumber	string	Registratienummer van het bedrijf.

Error

Object

Een fout van de Azure AgPlatform-service.

Name	Type	Description
code	string minLength: 1	Door de server gedefinieerde set foutcodes.
details	Error[]	Matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.
innererror	InnerError	Interne fout met een lijst met fouten. Zie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object voor innerError-referentiedocument.
message	string minLength: 1	Leesbare weergave van de fout.
target	string	Doel van de fout.

ErrorResponse

Object

Een foutreactie van de Azure AgPlatform-service. Zie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses voor het referentiedocument ErrorResponse.

Name	Type	Description
error	Error	Een fout van de Azure AgPlatform-service.
traceId	string	Unieke tracerings-id.

InnerError

Object

Interne fout met een lijst met fouten. Zie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object voor innerError-referentiedocument.

Name	Type	Description
code	string	Specifieke foutcode dan is opgegeven door de bijbehorende fout.
innererror	InnerError	Interne fout met een lijst met fouten. Zie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object voor innerError-referentiedocument.

Reference

Object

Verwijzing naar een gegevenssetrecord.

Name	Type	Description
datasetId	string minLength: 0 maxLength: 100	Gegevensset-id.
recordId	string minLength: 0 maxLength: 100	Record-id.

Delen via

Chemical Products - List

URI-parameters

Aanvraagkoptekst

Antwoorden

Beveiliging

Authorization

Voorbeelden

ChemicalProducts_List

Voorbeeldaanvraag

Voorbeeldrespons

Definities

ChemicalProduct

ChemicalProductListResponse

Company

Error

ErrorResponse

InnerError

Reference