Harvest Data - Get

Ссылка

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

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

Получите указанный ресурс данных сбора данных под определенной стороной.

GET /parties/{partyId}/harvest-data/{harvestDataId}?api-version=2023-04-01-preview

Параметры URI

Имя	В	Обязательно	Тип	Описание
harvestDataId	path	True	string	Идентификатор ресурса сбора данных.
partyId	path	True	string	Идентификатор связанного ресурса стороннего ресурса.
api-version	query	True	string	Запрошенная версия API

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

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

Ответы

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

Имя

Тип

Описание

200 OK

HarvestData

Успех

Other Status Codes

ErrorResponse

Ошибка

Заголовки

x-ms-error-code: string

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

Authorization

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

Тип: apiKey
В: header

Примеры

HarvestData_Get

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

HTTP

GET /parties/PARTY123/harvest-data/HARVESTOP123?api-version=2023-04-01-preview

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

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

{
  "partyId": "PARTY123",
  "id": "HARVESTOP123",
  "source": "Manual",
  "name": "Harvest data for North Farm",
  "description": "some description",
  "status": "Active",
  "operationStartDateTime": "2021-02-25T16:57:04Z",
  "operationEndDateTime": "2021-02-27T10:13:06Z",
  "operationModifiedDateTime": "2021-02-28T10:12:12Z",
  "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"
}

Определения

Имя	Описание
Error	Ошибка из службы Azure AgPlatform.
ErrorResponse	Ответ об ошибке службы Azure AgPlatform. Справочный документ ErrorResponse см. в https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
HarvestData	Схема ресурса сбора данных.
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	Схема для хранения чтения и единицы измерения.

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 - Get

Параметры URI

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

Ответы

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

Authorization

Примеры

HarvestData_Get

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

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

Определения

Error

ErrorResponse

HarvestData

HarvestProductDetail

InnerError

Measure