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


Harvest Data - List

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

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:мм:ссZ (включительно).

maxOperationModifiedDateTime
query

string

date-time

Максимальная измененная дата и время данных операции, пример формата: гггг-ММ-ддTHЧ:мм:ссZ (включительно).

maxOperationStartDateTime
query

string

date-time

Максимальная дата и время начала данных операции, пример формата: гггг-ММ-ддTHH:мм:ссZ (включительно).

maxPageSize
query

integer

int32

Максимальное количество необходимых элементов (включительно). Минимум = 10, максимум = 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

Минимальная дата и время окончания данных операции, формат образца: гггг-ММ-ддTHЧ:мм:ссЗ (включительно).

minOperationModifiedDateTime
query

string

date-time

Минимальная измененная дата и время данных операции, формат образца: гггг-ММ-ддTHЧ:мм:ссЗ (включительно).

minOperationStartDateTime
query

string

date-time

Минимальная дата и время начала данных операции, формат образца: гггг-ММ-ддTHЧч:мм:ссЗ (включительно).

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

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

Authorization

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

Тип: apiKey
В: header

Примеры

HarvestData_List

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

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

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

{
  "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. См https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses . справочный документ ErrorResponse.

HarvestData

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

HarvestDataListResponse

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

HarvestProductDetail

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

InnerError

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

Measure

Схема для хранения измерений и единиц измерения.

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

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

HarvestData

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

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

Measure

Схема для хранения измерений и единиц измерения.

associatedBoundaryId

string

Необязательный идентификатор границы поля, для которого была применена операция.

attachmentsLink

string

Ссылка для вложений.

avgMoisture

Measure

Схема для хранения измерений и единиц измерения.

avgSpeed

Measure

Схема для хранения измерений и единиц измерения.

avgWetMass

Measure

Схема для хранения измерений и единиц измерения.

avgYield

Measure

Схема для хранения измерений и единиц измерения.

createdBy

string

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

createdDateTime

string

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

description

string

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

eTag

string

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

harvestProductDetails

HarvestProductDetail[]

Сведения о продукте сбора.

id

string

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

modifiedBy

string

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

modifiedDateTime

string

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

name

string

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

operationEndDateTime

string

Дата и время окончания данных операции, пример формата: гггг-ММ-ддTHЧч:мм:ссZ.

operationModifiedDateTime

string

Изменена дата и время данных операции, пример формата: гггг-ММ-ддTHЧ:мм:ссЗ. Примечание. Этот параметр будет указан самим поставщиком источника.

operationStartDateTime

string

Дата и время начала данных операции, пример формата: гггг-ММ-ддTHЧ:мм:ссZ.

partyId

string

Идентификатор стороны, который принадлежит данным операции.

properties

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

source

string

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

status

string

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

totalWetMass

Measure

Схема для хранения измерений и единиц измерения.

totalYield

Measure

Схема для хранения измерений и единиц измерения.

HarvestDataListResponse

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

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

string

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

skipToken

string

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

value

HarvestData[]

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

HarvestProductDetail

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

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

Measure

Схема для хранения измерений и единиц измерения.

avgMoisture

Measure

Схема для хранения измерений и единиц измерения.

avgWetMass

Measure

Схема для хранения измерений и единиц измерения.

avgYield

Measure

Схема для хранения измерений и единиц измерения.

productName

string

Имя продукта.

totalWetMass

Measure

Схема для хранения измерений и единиц измерения.

totalYield

Measure

Схема для хранения измерений и единиц измерения.

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.

Measure

Схема для хранения измерений и единиц измерения.

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

string

Единица данных.

value

number

Значение данных.