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}®istrationNumber={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 |
active
|
query |
string[] |
ActiveIngredients de produto químico. |
|
brands
|
query |
string[] |
Marcas de produto químico. |
|
company
|
query |
string[] |
Nomes da empresa de produtos químicos. |
|
crop
|
query |
string[] |
CropIds de produto químico. |
|
dataset
|
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[] |
Localizações do produto químico. |
|
max
|
query |
string (date-time) |
Data máxima de criação do recurso (inclusive). |
|
max
|
query |
string (date-time) |
Data máxima da última modificação do recurso (inclusive). |
|
max
|
query |
integer (int32) minimum: 10maximum: 1000 |
Número máximo de itens necessários (inclusive). Mínimo = 10, Máximo = 1000, Valor padrão = 50. |
|
max
|
query |
integer (int32) |
Max ReEntryInterval do produto químico. |
|
min
|
query |
string (date-time) |
Data mínima de criação do recurso (inclusive). |
|
min
|
query |
string (date-time) |
Data mínima da última modificação do recurso (inclusive). |
|
min
|
query |
integer (int32) |
Min ReEntryInterval do produto químico. |
|
names
|
query |
string[] |
Nomes do recurso. |
|
products
|
query |
string[] |
Produtos de produto químico. |
|
property
|
query |
string[] |
Filtra os pares chave-valor dentro do objeto Properties. Eg. "{testKey} eq {testValue}". |
|
reference
|
query |
string[] |
ID de registro de referência do produto químico. |
|
registration
|
query |
string[] |
RegistrationNumber do produto químico. |
|
skip
|
query |
string |
Ignore o token para obter o próximo conjunto de resultados. |
|
specific
|
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ê tentou chamadas não autenticadas antes. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
Êxito |
|
Other Status Codes |
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ê 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 |
---|---|
Chemical |
Esquema de recurso ChemicalProduct. |
Chemical |
A resposta paginada contém uma 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. |
Error |
Uma resposta de erro do serviço Azure AgPlatform. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses para o documento de referência ErrorResponse. |
Inner |
Erro interno que contém a lista de erros. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object para o documento de referência InnerError. |
Reference |
Referência a um registro de conjunto de dados. |
ChemicalProduct
Esquema de recurso ChemicalProduct.
Nome | Tipo | Description |
---|---|---|
activeIngredients |
string[] |
Produtos químicos ativos na formulação. |
brand |
string |
Marca comercial do produto químico. |
company |
Detalhes da empresa/fabricante. |
|
createdBy |
string |
Criado por ID de usuário/locatário. |
createdDateTime |
string (date-time) |
Data/hora em que o recurso foi criado, formato de exemplo: 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 minLength: 0maxLength: 500 |
Descrição textual do recurso. |
eTag |
string |
O valor ETag para implementar a simultaneidade otimista. |
formulation |
string |
Descrição da formulação. Porcentagem ou outra unidade de N, P, K, CA, MG, S, FE, MN, ZN,, 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 pela ID do usuário/locatário. |
modifiedDateTime |
string (date-time) |
Data/hora em que o recurso foi modificado pela última vez, formato de exemplo: yyyy-MM-ddTHH:mm:ssZ. |
name |
string minLength: 0maxLength: 100 |
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: um máximo de 25 pares de valor de chave pode ser fornecido para um recurso e somente valores de cadeia de caracteres, numeral e datetime (yyyy-MM-ddTHH:mm:ssZ) têm suporte. |
|
reEntryInterval |
integer (int32) |
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 |
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 minLength: 2maxLength: 100 |
Origem do recurso. |
specificGravity |
string |
Detalhes específicos da gravidade. |
state |
string |
Líquido/não Líquido. |
status |
string minLength: 0maxLength: 100 |
Status do recurso. |
type |
string |
Herbicida, Aditivo, Inseticidas, Fertilizantes. |
ChemicalProductListResponse
A resposta paginada contém uma 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 |
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 minLength: 1 |
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 |
Erro interno que contém a lista de erros. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object para o documento de referência InnerError. |
|
message |
string minLength: 1 |
Representação legível por humanos 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 para o documento de referência ErrorResponse.
Nome | Tipo | Description |
---|---|---|
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 para o documento de referência InnerError.
Nome | Tipo | Description |
---|---|---|
code |
string |
Código de erro específico que foi fornecido pelo erro que contém. |
innererror |
Erro interno que contém a lista de erros. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object para o documento de referência InnerError. |
Reference
Referência a um registro de conjunto de dados.
Nome | Tipo | Description |
---|---|---|
datasetId |
string minLength: 0maxLength: 100 |
ID do conjunto de dados. |
recordId |
string minLength: 0maxLength: 100 |
ID do registro. |