Delen via


Chemical Products - List

Retourneert een gepagineerde lijst met chemische productresources.

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

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

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 de resource (inclusief).

minLastModifiedDateTime
query

string

date-time

Minimale datum van laatste wijziging van de resource (inclusief).

minReEntryInterval
query

integer

int32

Min ReEntryInterval van chemisch product.

names
query

string[]

Namen van de resource.

products
query

string[]

Producten van chemische producten.

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

Token overslaan voor het ophalen van de volgende set resultaten.

specificGravity
query

string[]

SpecificGravity of chemical 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 mogelijk uw browsercache 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

Beveiliging

Authorization

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

Type: apiKey
In: header

Voorbeelden

ChemicalProducts_List

Voorbeeldaanvraag

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

Voorbeeldrespons

{
  "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 de resource ChemicalProduct.

ChemicalProductListResponse

Paged-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 het referentiedocument innerError voor meer informatie.

Reference

Verwijzing naar een gegevenssetrecord.

ChemicalProduct

Schema van de resource ChemicalProduct.

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 de gebruiker/tenant-id.

createdDateTime

string

Datum/tijd waarop de resource is gemaakt, voorbeeldindeling: jjjj-MM-ddTHH:mm:ssZ.

cropIds

string[]

De id's van de gewassen die zijn gekoppeld aan het chemische product. Opmerking: Er kunnen maximaal 25 gewassen aan een cropProduct worden gekoppeld.

description

string

Tekstuele beschrijving van de resource.

eTag

string

De ETag-waarde voor het implementeren van optimistische gelijktijdigheid.

formulation

string

Beschrijving van formulering. Percentage of een andere eenheid van N, P, K, CA, MG, S, FE, MN, ZN, CU, B, MO, CL (op basis van de bron kunnen de beschikbare chemische elementen 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 gebruiker/tenant-id.

modifiedDateTime

string

Datum/tijd waarop de resource voor het laatst is gewijzigd, voorbeeldindeling: jjjj-MM-ddTHH:mm:ssZ.

name

string

Naam om de resource te identificeren.

product

string

Commerciële productnaam van het chemische product.

properties

Een verzameling sleutelwaardeparen die deel uitmaakt van de resource. Elk paar mag geen sleutel hebben die langer is dan 50 tekens en mag geen waarde van meer dan 150 tekens hebben. Opmerking: er kunnen maximaal 25 sleutelwaardeparen worden opgegeven voor een resource en alleen waarden voor tekenreeks, numeriek en datum/tijd (jjjj-MM-ddTHH:mm:ssZ) worden ondersteund.

reEntryInterval

integer

Het aantal dagen waarna een persoon het veld kan bezoeken nadat het chemische product is aangebracht.

reference

Reference

Verwijzing naar een gegevenssetrecord.

registrationNumber

string

Registratienummer van de chemische stof. Dit kan per geografie verschillen.

source

string

Bron van de resource.

specificGravity

string

Specifieke zwaartekrachtdetails.

state

string

Vloeibaar/niet-vloeibaar.

status

string

Status van de resource.

type

string

Insecticide, Additief, Insecticiden, Meststoffen.

ChemicalProductListResponse

Paged-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 dit null is, zijn er geen extra pagina's.

value

ChemicalProduct[]

Lijst met aangevraagde objecten.

Company

Bedrijfs-/fabrikantgegevens.

Name Type Description
description

string

Beschrijving van productiebedrijf.

name

string

Naam van het productiebedrijf.

registrationNumber

string

Registratienummer van het bedrijf.

Error

Een fout van de Azure AgPlatform-service.

Name Type Description
code

string

Door de server gedefinieerde set foutcodes.

details

Error[]

Matrix met details over specifieke fouten die tot deze gerapporteerde fout hebben geleid.

innererror

InnerError

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

message

string

Door mensen leesbare weergave van de fout.

target

string

Doel van de fout.

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.

Name Type Description
error

Error

Een fout van de Azure AgPlatform-service.

traceId

string

Unieke tracerings-id.

InnerError

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

Name Type Description
code

string

Specifieke foutcode dan is opgegeven door de betreffende fout.

innererror

InnerError

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

Reference

Verwijzing naar een gegevenssetrecord.

Name Type Description
datasetId

string

Gegevensset-id.

recordId

string

Record-id.