Поделиться через


Chemical Products - List

Возвращает список ресурсов химической продукции с разбивкой на страницы.

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

Имя В Обязательно Тип Описание
endpoint
path True

string

uri

Имя узла пространства имен, например admaInstanceName.farmbeats.azure.net

api-version
query True

string

Запрошенная версия API

activeIngredients
query

string[]

ActiveIngredients химического продукта.

brands
query

string[]

Бренды химической продукции.

companyNames
query

string[]

Названия компаний химической продукции.

cropIds
query

string[]

CropId химического продукта.

datasetIds
query

string[]

Идентификатор эталонного набора данных химического продукта.

formulation
query

string[]

Рецептура химического продукта.

ids
query

string[]

Идентификаторы ресурса.

locations
query

string[]

Расположения химической продукции.

maxCreatedDateTime
query

string

date-time

Максимальная дата создания ресурса (включительно).

maxLastModifiedDateTime
query

string

date-time

Максимальная дата последнего изменения ресурса (включительно).

maxPageSize
query

integer

int32

Максимальное количество необходимых элементов (включительно). Минимум = 10, максимум = 1000, значение по умолчанию = 50.

maxReEntryInterval
query

integer

int32

Max ReEntryInterval химического продукта.

minCreatedDateTime
query

string

date-time

Минимальная дата создания ресурса (включительно).

minLastModifiedDateTime
query

string

date-time

Минимальная дата последнего изменения ресурса (включительно).

minReEntryInterval
query

integer

int32

Min ReEntryInterval химического продукта.

names
query

string[]

Имена ресурса.

products
query

string[]

Продукты химической продукции.

propertyFilters
query

string[]

Фильтрует пары "ключ-значение" в объекте Properties. Например: "{testKey} eq {testValue}".

referenceRecordIds
query

string[]

Идентификатор справочной записи химической продукции.

registrationNumber
query

string[]

RegistrationNumber of chemical product.

skipToken
query

string

Пропуск маркера для получения следующего набора результатов.

specificGravity
query

string[]

Специфика гравитации химического продукта.

states
query

string[]

Состояния химической продукции.

statuses
query

string[]

Состояния ресурса.

types
query

string[]

Виды химической продукции.

Заголовок запроса

Имя Обязательно Тип Описание
Authorization True

string

Укажите допустимый маркер носителя для авторизованных вызовов API. Обратите внимание, что может потребоваться очистить кэш браузера, если вы ранее пытались выполнить вызовы без проверки подлинности.

Ответы

Имя Тип Описание
200 OK

ChemicalProductListResponse

Успех

Other Status Codes

ErrorResponse

Ошибка

Заголовки

x-ms-error-code: string

Безопасность

Authorization

Укажите допустимый маркер носителя для авторизованных вызовов API. Обратите внимание, что может потребоваться очистить кэш браузера, если вы ранее пытались выполнить вызовы без проверки подлинности.

Тип: apiKey
В: header

Примеры

ChemicalProducts_List

Образец запроса

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

Пример ответа

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

Определения

Имя Описание
ChemicalProduct

Схема ресурса ChemicalProduct.

ChemicalProductListResponse

Выстраиваемый ответ содержит список запрошенных объектов и skipToken для получения следующего набора результатов.

Company

Сведения о компании или изготовителе.

Error

Ошибка из службы Azure AgPlatform.

ErrorResponse

Ответ об ошибке от службы Azure AgPlatform. См. https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses справочный документ ErrorResponse.

InnerError

Внутренняя ошибка, содержащая список ошибок. См. https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object справочный документ InnerError.

Reference

Ссылка на запись набора данных.

ChemicalProduct

Схема ресурса ChemicalProduct.

Имя Тип Описание
activeIngredients

string[]

Активные химические вещества в составе.

brand

string

Коммерческая марка химической продукции.

company

Company

Сведения о компании или изготовителе.

createdBy

string

Создается по идентификатору пользователя или клиента.

createdDateTime

string

Дата и время создания ресурса. Пример формата: yyyy-MM-ddTHH:mm:ssZ.

cropIds

string[]

Идентификаторы культур, связанных с химическим продуктом. Примечание. С cropProduct можно связать не более 25 культур.

description

string

Текстовое описание ресурса.

eTag

string

Значение ETag для реализации оптимистичного параллелизма.

formulation

string

Описание формулировки. Процент или другая единица N, P, K, CA, MG, S, FE, MN, ZN, CU, B, MO, CL (в зависимости от источника доступные химические элементы могут различаться, но это типичный список).

id

string

Уникальный идентификатор ресурса.

location

string

Область, где используется химическое вещество. Это важно с точки зрения соответствия требованиям.

modifiedBy

string

Изменен по идентификатору пользователя или клиента.

modifiedDateTime

string

Дата и время последнего изменения ресурса. Пример формата: yyyy-MM-ddTHH:mm:ssZ.

name

string

Имя для идентификации ресурса.

product

string

Коммерческое название химического продукта.

properties

Коллекция пар "ключ-значение", принадлежащих ресурсу. Каждая пара не должна содержать ключ, превышающий 50 символов, и значение не должно превышать 150 символов. Примечание. Для ресурса можно указать не более 25 пар ключевых значений, и поддерживаются только строковые, числовые значения и значения даты и времени (гггг-ММ-ддТЧЧ:мм:ссЗ).

reEntryInterval

integer

Количество дней, по истечении которых человек может посетить поле после применения химического продукта.

reference

Reference

Ссылка на запись набора данных.

registrationNumber

string

Регистрационный номер химического вещества. Это может быть разным в зависимости от географического региона.

source

string

Источник ресурса.

specificGravity

string

Детали удельного веса.

state

string

Жидкая/нежидкая.

status

string

Состояние ресурса.

type

string

Гербицид, аддитивные, инсектициды, удобрения.

ChemicalProductListResponse

Выстраиваемый ответ содержит список запрошенных объектов и skipToken для получения следующего набора результатов.

Имя Тип Описание
nextLink

string

Ссылка продолжения (абсолютный URI), указывающая на следующую страницу списка результатов.

skipToken

string

Маркер, используемый при получении следующей страницы. Если значение равно null, дополнительные страницы отсутствуют.

value

ChemicalProduct[]

Список запрошенных объектов.

Company

Сведения о компании или изготовителе.

Имя Тип Описание
description

string

Описание производственной компании.

name

string

Название производственной компании.

registrationNumber

string

Регистрационный номер компании.

Error

Ошибка из службы Azure AgPlatform.

Имя Тип Описание
code

string

Определенный сервером набор кодов ошибок.

details

Error[]

Массив сведений о конкретных ошибках, которые привели к этой сообщаемой ошибке.

innererror

InnerError

Внутренняя ошибка, содержащая список ошибок. См. https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object справочный документ InnerError.

message

string

Читаемое представление ошибки.

target

string

Целевой объект ошибки.

ErrorResponse

Ответ об ошибке от службы Azure AgPlatform. См. https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses справочный документ ErrorResponse.

Имя Тип Описание
error

Error

Ошибка из службы Azure AgPlatform.

traceId

string

Уникальный идентификатор трассировки.

InnerError

Внутренняя ошибка, содержащая список ошибок. См. https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object справочный документ InnerError.

Имя Тип Описание
code

string

Конкретный код ошибки, чем был предоставлен содержащей ошибкой.

innererror

InnerError

Внутренняя ошибка, содержащая список ошибок. См. https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object справочный документ InnerError.

Reference

Ссылка на запись набора данных.

Имя Тип Описание
datasetId

string

Идентификатор набора данных.

recordId

string

Идентификатор записи.