Compartilhar via


Chemical Products - List

Retorna uma lista paginada de recursos de produtos químicos.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
endpoint
path True

string

uri

O nome do host do namespace, por exemplo, admaInstanceName.farmbeats.azure.net

api-version
query True

string

A versão da API solicitada

activeIngredients
query

string[]

ActiveIngredients de produto químico.

brands
query

string[]

Marcas de produtos químicos.

companyNames
query

string[]

Nomes da empresa de produtos químicos.

cropIds
query

string[]

CropIds de produto químico.

datasetIds
query

string[]

ID do conjunto de dados de referência do produto químico.

formulation
query

string[]

Formulação de produto químico.

ids
query

string[]

IDs do recurso.

locations
query

string[]

Locais do produto químico.

maxCreatedDateTime
query

string

date-time

Data máxima de criação do recurso (inclusive).

maxLastModifiedDateTime
query

string

date-time

Data máxima da última modificação do recurso (inclusive).

maxPageSize
query

integer

int32

Número máximo de itens necessários (inclusive). Mínimo = 10, Máximo = 1000, Valor padrão = 50.

maxReEntryInterval
query

integer

int32

Max ReEntryInterval de produto químico.

minCreatedDateTime
query

string

date-time

Data mínima de criação do recurso (inclusive).

minLastModifiedDateTime
query

string

date-time

Data mínima da última modificação do recurso (inclusive).

minReEntryInterval
query

integer

int32

ReEntryInterval mínimo de produto químico.

names
query

string[]

Nomes do recurso.

products
query

string[]

Produtos de produtos químicos.

propertyFilters
query

string[]

Filtra os pares chave-valor dentro do objeto Properties. ex. "{testKey} eq {testValue}".

referenceRecordIds
query

string[]

ID de registro de referência do produto químico.

registrationNumber
query

string[]

RegistrationNumber de produto químico.

skipToken
query

string

Ignore o token para obter o próximo conjunto de resultados.

specificGravity
query

string[]

SpecificGravity do produto químico.

states
query

string[]

Estados do produto químico.

statuses
query

string[]

Status do recurso.

types
query

string[]

Tipos de produto químico.

Cabeçalho da solicitação

Nome Obrigatório Tipo Description
Authorization True

string

Forneça um token de portador válido para chamadas de API autorizadas. Observe que talvez seja necessário limpar o cache do navegador se você já tentou chamadas não autenticadas antes.

Respostas

Nome Tipo Description
200 OK

ChemicalProductListResponse

Êxito

Other Status Codes

ErrorResponse

Erro

Cabeçalhos

x-ms-error-code: string

Segurança

Authorization

Forneça um token de portador válido para chamadas de API autorizadas. Observe que talvez seja necessário limpar o cache do navegador se você já tentou chamadas não autenticadas antes.

Tipo: apiKey
Em: header

Exemplos

ChemicalProducts_List

Solicitação de exemplo

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

Resposta de exemplo

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

Definições

Nome Description
ChemicalProduct

Esquema do recurso ChemicalProduct.

ChemicalProductListResponse

A resposta paginada contém a lista de objetos solicitados e um skipToken para obter o próximo conjunto de resultados.

Company

Detalhes da empresa/fabricante.

Error

Um erro do serviço AgPlatform do Azure.

ErrorResponse

Uma resposta de erro do serviço Azure AgPlatform. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses o documento de referência ErrorResponse.

InnerError

Erro interno que contém a lista de erros. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object o documento de referência InnerError.

Reference

Referência a um registro de conjunto de dados.

ChemicalProduct

Esquema do recurso ChemicalProduct.

Nome Tipo Description
activeIngredients

string[]

Produtos químicos ativos na formulação.

brand

string

Marca comercial do produto químico.

company

Company

Detalhes da empresa/fabricante.

createdBy

string

Criado por ID de usuário/locatário.

createdDateTime

string

Data e hora em que o recurso foi criado; formato de amostra: yyyy-MM-ddTHH:mm:ssZ.

cropIds

string[]

As IDs das culturas associadas ao produto químico. Observação: no máximo 25 culturas podem ser associadas a um cropProduct.

description

string

Descrição textual do recurso.

eTag

string

O valor ETag para implementar simultaneidade otimista.

formulation

string

Descrição da formulação. Percentual ou outra unidade de N, P, K, CA, MG, S, FE, MN, ZN, CU, B, MO, CL (com base na origem, os elementos químicos disponíveis podem variar, mas essa é uma lista típica).

id

string

ID de recurso exclusiva.

location

string

Área onde o produto químico é usado. Isso é importante do ponto de vista da conformidade.

modifiedBy

string

Modificado por ID de usuário/locatário.

modifiedDateTime

string

Data e hora em que o recurso foi modificado pela última vez; formato de amostra: yyyy-MM-ddTHH:mm:ssZ.

name

string

Nome para identificar o recurso.

product

string

Nome do produto comercial do produto químico.

properties

Uma coleção de pares de valores de chave que pertence ao recurso. Cada par não deve ter uma chave maior que 50 caracteres e não deve ter um valor maior que 150 caracteres. Observação: há suporte para um máximo de 25 pares de valores de chave para um recurso e apenas valores de cadeia de caracteres, numeral e datetime (yyyy-MM-ddTHH:mm:ssZ).

reEntryInterval

integer

O número de dias após o qual uma pessoa pode visitar o campo após a aplicação do produto químico.

reference

Reference

Referência a um registro de conjunto de dados.

registrationNumber

string

Número de registro do produto químico. Isso pode variar de acordo com a geografia.

source

string

Origem do recurso.

specificGravity

string

Detalhes específicos da gravidade.

state

string

Liquid/non Liquid.

status

string

Status do recurso.

type

string

Herbicida, Aditivo, Inseticidas, Fertilizantes.

ChemicalProductListResponse

A resposta paginada contém a lista de objetos solicitados e um skipToken para obter o próximo conjunto de resultados.

Nome Tipo Description
nextLink

string

Link de continuação (URI absoluto) para a próxima página de resultados na lista.

skipToken

string

Token usado na recuperação da próxima página. Se for nulo, não haverá páginas adicionais.

value

ChemicalProduct[]

Lista de objetos solicitados.

Company

Detalhes da empresa/fabricante.

Nome Tipo Description
description

string

Descrição da Empresa de Fabricação.

name

string

Nome da empresa de fabricação.

registrationNumber

string

Número de registro da empresa.

Error

Um erro do serviço AgPlatform do Azure.

Nome Tipo Description
code

string

Conjunto definido pelo servidor de códigos de erro.

details

Error[]

Matriz de detalhes sobre erros específicos que levaram a esse erro relatado.

innererror

InnerError

Erro interno que contém a lista de erros. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object o documento de referência InnerError.

message

string

Representação legível ao olho humano do erro.

target

string

Destino do erro.

ErrorResponse

Uma resposta de erro do serviço Azure AgPlatform. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses o documento de referência ErrorResponse.

Nome Tipo Description
error

Error

Um erro do serviço AgPlatform do Azure.

traceId

string

ID de rastreamento exclusiva.

InnerError

Erro interno que contém a lista de erros. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object o documento de referência InnerError.

Nome Tipo Description
code

string

Código de erro específico do que foi fornecido pelo erro que contém.

innererror

InnerError

Erro interno que contém a lista de erros. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object o documento de referência InnerError.

Reference

Referência a um registro de conjunto de dados.

Nome Tipo Description
datasetId

string

ID do conjunto de dados.

recordId

string

ID do registro.