Harvest Data - List

Служба:: Azure Data Manager for Agriculture

Версия API:: 2023-06-01-preview

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

GET /harvest-data?api-version=2023-06-01-preview

С использованием необязательных параметров:

GET /harvest-data?minTotalYield={minTotalYield}&maxTotalYield={maxTotalYield}&minAvgYield={minAvgYield}&maxAvgYield={maxAvgYield}&minTotalWetMass={minTotalWetMass}&maxTotalWetMass={maxTotalWetMass}&minAvgWetMass={minAvgWetMass}&maxAvgWetMass={maxAvgWetMass}&minAvgMoisture={minAvgMoisture}&maxAvgMoisture={maxAvgMoisture}&minAvgSpeed={minAvgSpeed}&maxAvgSpeed={maxAvgSpeed}&sources={sources}&associatedBoundaryIds={associatedBoundaryIds}&minOperationStartDateTime={minOperationStartDateTime}&maxOperationStartDateTime={maxOperationStartDateTime}&minOperationEndDateTime={minOperationEndDateTime}&maxOperationEndDateTime={maxOperationEndDateTime}&minOperationModifiedDateTime={minOperationModifiedDateTime}&maxOperationModifiedDateTime={maxOperationModifiedDateTime}&minArea={minArea}&maxArea={maxArea}&ids={ids}&names={names}&propertyFilters={propertyFilters}&statuses={statuses}&minCreatedDateTime={minCreatedDateTime}&maxCreatedDateTime={maxCreatedDateTime}&minLastModifiedDateTime={minLastModifiedDateTime}&maxLastModifiedDateTime={maxLastModifiedDateTime}&maxPageSize={maxPageSize}&skipToken={skipToken}&api-version=2023-06-01-preview

Параметры URI

Имя	В	Обязательно	Тип	Описание
api-version	query	True	string	Запрошенная версия API
associatedBoundaryIds	query		string[]	Идентификаторы границ, связанные с данными операции.
ids	query		string[]	Идентификаторы ресурса.
maxArea	query		number (double)	Максимальная область, для которой была применена операция (включительно).
maxAvgMoisture	query		number (double)	Максимальное значение AvgMoisture (включительно).
maxAvgSpeed	query		number (double)	Максимальное значение AvgSpeed (включительно).
maxAvgWetMass	query		number (double)	Максимальное значение AvgWetMass (включительно).
maxAvgYield	query		number (double)	Максимальное значение AvgYield (включительно).
maxCreatedDateTime	query		string (date-time)	Максимальная дата создания ресурса (включительно).
maxLastModifiedDateTime	query		string (date-time)	Максимальная дата последнего изменения ресурса (включительно).
maxOperationEndDateTime	query		string (date-time)	Максимальное время окончания данных операции, пример формата: гггг-ММ-ддTHH:мм:ssZ (включительно).
maxOperationModifiedDateTime	query		string (date-time)	Максимальный измененный формат данных операции: гггг-ММ-ддTHH:мм:ssZ (включительно).
maxOperationStartDateTime	query		string (date-time)	Максимальное время начала данных операции, пример формата: гггг-ММ-ддTHH:мм:ssZ (включительно).
maxPageSize	query		integer (int32) minimum: 10 maximum: 1000	Максимальное количество необходимых элементов (включительно). Minimum = 10, Maximum = 1000, Значение по умолчанию = 50.
maxTotalWetMass	query		number (double)	Максимальное значение WetMass (включительно).
maxTotalYield	query		number (double)	Максимальное значение доходности (включительно).
minArea	query		number (double)	Минимальная область, для которой была применена операция (включительно).
minAvgMoisture	query		number (double)	Минимальное значение AvgMoisture (включительно).
minAvgSpeed	query		number (double)	Минимальное значение AvgSpeed (включительно).
minAvgWetMass	query		number (double)	Минимальное значение AvgWetMass (включительно).
minAvgYield	query		number (double)	Минимальное значение AvgYield (включительно).
minCreatedDateTime	query		string (date-time)	Минимальная дата создания ресурса (включительно).
minLastModifiedDateTime	query		string (date-time)	Минимальная дата последнего изменения ресурса (включительно).
minOperationEndDateTime	query		string (date-time)	Минимальное время окончания данных операции, пример формата: гггг-ММ-ддTHH:мм:ssZ (включительно).
minOperationModifiedDateTime	query		string (date-time)	Минимальный измененный формат данных операции: гггг-ММ-ддTHH:мм:ssZ (включительно).
minOperationStartDateTime	query		string (date-time)	Минимальное время начала данных операции, формат образца: гггг-ММ-ддTHH:мм:ssZ (включительно).
minTotalWetMass	query		number (double)	Минимальное значение WetMass (включительно).
minTotalYield	query		number (double)	Минимальное значение доходности (включительно).
names	query		string[]	Имена ресурса.
propertyFilters	query		string[]	Фильтрует пары "ключ-значение" в объекте Properties. Например. "{testKey} eq {testValue}".
skipToken	query		string	Пропустите маркер получения следующего набора результатов.
sources	query		string[]	Источники данных операции.
statuses	query		string[]	Состояния ресурса.

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

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

Ответы

Имя	Тип	Описание
200 OK	HarvestDataListResponse	Успех
Other Status Codes	ErrorResponse	Ошибка Заголовки x-ms-error-code: string

Имя

Тип

Описание

200 OK

HarvestDataListResponse

Успех

Other Status Codes

ErrorResponse

Ошибка

Заголовки

x-ms-error-code: string

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

Authorization

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

Тип: apiKey
В: header

Примеры

HarvestData_List

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

HTTP

GET /harvest-data?api-version=2023-06-01-preview

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

Код состояния:: 200

{
  "value": [
    {
      "partyId": "PARTY123",
      "id": "HARVESTOP123",
      "source": "Manual",
      "name": "Harvest data for North Farm",
      "description": "some description",
      "status": "Active",
      "operationStartDateTime": "2021-04-21T06:49:30Z",
      "operationEndDateTime": "2021-04-21T06:49:30Z",
      "operationModifiedDateTime": "2021-04-21T06:49:30Z",
      "associatedBoundaryId": "NORTHFARM2021CORNBOUNDARY",
      "area": {
        "unit": "acre",
        "value": 50
      },
      "totalYield": {
        "unit": "kilos",
        "value": 1400
      },
      "avgYield": {
        "unit": "kilosperacre",
        "value": 28
      },
      "totalWetMass": {
        "unit": "kilos",
        "value": 500
      },
      "avgWetMass": {
        "unit": "kilosperacre",
        "value": 10
      },
      "avgMoisture": {
        "unit": "percent",
        "value": 14.61
      },
      "avgSpeed": {
        "unit": "kmsperhour",
        "value": 7.2
      },
      "harvestProductDetails": [
        {
          "productName": "VAR1",
          "area": {
            "unit": "acre",
            "value": 30
          },
          "totalYield": {
            "unit": "kilos",
            "value": 900
          },
          "avgYield": {
            "unit": "kilosperacre",
            "value": 30
          },
          "totalWetMass": {
            "unit": "kilos",
            "value": 300
          },
          "avgWetMass": {
            "unit": "kilosperacre",
            "value": 10
          },
          "avgMoisture": {
            "unit": "percent",
            "value": 16.4
          }
        }
      ],
      "properties": {
        "Region": "Europe",
        "CountyCode": 123
      },
      "attachmentsLink": "https://<resource-name>.farmbeats.azure.net/party/{{partyId}}/attachments?api-version={{apiVersion}}&resourceIds={{harvestDataId}}&resourceTypes=HarvestData",
      "createdDateTime": "2021-04-21T06:49:30Z",
      "modifiedDateTime": "2021-04-21T06:49:30Z",
      "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000"
    }
  ],
  "skipToken": "string",
  "nextLink": "https:/{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/harvestData?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7ehK8eAKzdo1MNnwcAAAAAAA%3d%3d%23RT%3a1%23TRC%3a10%23ISV%3a2%23IEO%3a65551%23FPC%3aAQ2fBwAAAAAAD58HAAAAAAA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d"
}

Определения

Имя	Описание
Error	Ошибка из службы Azure AgPlatform.
ErrorResponse	Ответ об ошибке службы Azure AgPlatform. Справочный документ ErrorResponse см. в https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
HarvestData	Схема ресурса сбора данных.
HarvestDataListResponse	Ответ paged содержит список запрошенных объектов и URL-ссылку, чтобы получить следующий набор результатов.
HarvestProductDetail	Схема продукта, используемого во время сбора урожая.
InnerError	Внутренняя ошибка, содержащая список ошибок. См. https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object справочный документ InnerError.
Measure	Схема для хранения чтения и единицы измерения.

Error

Object

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

Имя	Тип	Описание
code	string minLength: 1	Определяемый сервером набор кодов ошибок.
details	Error[]	Массив сведений об определенных ошибках, которые привели к этой сообщаемой ошибке.
innererror	InnerError	Внутренняя ошибка, содержащая список ошибок. См. https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object справочный документ InnerError.
message	string minLength: 1	Читаемое человеком представление ошибки.
target	string	Цель ошибки.

ErrorResponse

Object

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

Имя	Тип	Описание
error	Error	Ошибка из службы Azure AgPlatform.
traceId	string	Уникальный идентификатор трассировки.

HarvestData

Object

Схема ресурса сбора данных.

Имя	Тип	Описание
area	Measure	Схема для хранения чтения и единицы измерения.
associatedBoundaryId	string	Необязательный идентификатор границы поля, для которого была применена операция.
attachmentsLink	string	Ссылка для вложений.
avgMoisture	Measure	Схема для хранения чтения и единицы измерения.
avgSpeed	Measure	Схема для хранения чтения и единицы измерения.
avgWetMass	Measure	Схема для хранения чтения и единицы измерения.
avgYield	Measure	Схема для хранения чтения и единицы измерения.
createdBy	string	Создан идентификатором пользователя или клиента.
createdDateTime	string (date-time)	Дата создания ресурса, пример формата: гггг-ММ-ддTHH:мм:ssZ.
description	string minLength: 0 maxLength: 500	Текстовое описание ресурса.
eTag	string	Значение ETag для реализации оптимистического параллелизма.
harvestProductDetails	HarvestProductDetail[]	Сбор сведений о продукте.
id	string	Уникальный идентификатор ресурса.
modifiedBy	string	Изменен идентификатором пользователя или клиента.
modifiedDateTime	string (date-time)	Дата и время последнего изменения ресурса: формат yy-MM-ddTHH:mm:ssZ.
name	string minLength: 0 maxLength: 100	Имя для идентификации ресурса.
operationEndDateTime	string (date-time)	Время окончания данных операции, пример формата: гггг-ММ-ддTHH:мм:ssZ.
operationModifiedDateTime	string (date-time)	Изменено время выполнения операций, пример формата: гггг-ММ-ддTHH:мм:ssZ. Примечание. Это будет указано самим поставщиком источника.
operationStartDateTime	string (date-time)	Дата начала данных операции, пример формата: гггг-ММ-ддTHH:мм:ssZ.
partyId	string	Идентификатор участника, принадлежащий данным операции.
properties		Коллекция пар значений ключей, принадлежащих ресурсу. Каждая пара не должна иметь ключ больше 50 символов и не должна иметь значение больше 150 символов. Примечание. Поддерживаются не более 25 пар значений ключей для ресурса и только строк, числовых и датовых значений (гггг-ММ-ддTHH:мм:ssZ).
source	string minLength: 2 maxLength: 100	Источник ресурса.
status	string minLength: 0 maxLength: 100	Состояние ресурса.
totalWetMass	Measure	Схема для хранения чтения и единицы измерения.
totalYield	Measure	Схема для хранения чтения и единицы измерения.

HarvestDataListResponse

Object

Ответ paged содержит список запрошенных объектов и URL-ссылку, чтобы получить следующий набор результатов.

Имя	Тип	Описание
nextLink	string	Ссылка на продолжение (абсолютный URI) на следующую страницу результатов в списке.
skipToken	string	Маркер, используемый при получении следующей страницы. Если значение NULL, дополнительные страницы отсутствуют.
value	HarvestData[]	Список запрошенных объектов.

HarvestProductDetail

Object

Схема продукта, используемого во время сбора урожая.

Имя	Тип	Описание
area	Measure	Схема для хранения чтения и единицы измерения.
avgMoisture	Measure	Схема для хранения чтения и единицы измерения.
avgWetMass	Measure	Схема для хранения чтения и единицы измерения.
avgYield	Measure	Схема для хранения чтения и единицы измерения.
productName	string minLength: 1 maxLength: 100	Имя продукта.
totalWetMass	Measure	Схема для хранения чтения и единицы измерения.
totalYield	Measure	Схема для хранения чтения и единицы измерения.

InnerError

Object

Внутренняя ошибка, содержащая список ошибок. См. 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.

Measure

Object

Схема для хранения чтения и единицы измерения.

Имя	Тип	Описание
unit	string minLength: 1 maxLength: 50	Единица данных.
value	number (double)	Значение данных.

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

Harvest Data - List

Параметры URI

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

Ответы

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

Authorization

Примеры

HarvestData_List

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

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

Определения

Error

ErrorResponse

HarvestData

HarvestDataListResponse

HarvestProductDetail

InnerError

Measure