Harvest Data - Get

Service:: Azure Data Manager for Agriculture

API Version:: 2023-11-01-preview

Get a specified harvest data resource under a particular party.

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string (uri)	The host name of the namespace, e.g. admaInstanceName.farmbeats.azure.net
harvestDataId	path	True	string	ID of the harvest data resource.
partyId	path	True	string	ID of the associated party resource.
api-version	query	True	string	The requested API version

Request Header

Name	Required	Type	Description
Authorization	True	string	Please provide a valid bearer token for authorized API calls. Note that you might need to clear your browser cache if you tried un-authenticated calls before.

Responses

Name	Type	Description
200 OK	HarvestData	Success
Other Status Codes	ErrorResponse	Error Headers x-ms-error-code: string

Name

Type

Description

200 OK

HarvestData

Success

Other Status Codes

ErrorResponse

Error

Headers

x-ms-error-code: string

Security

Authorization

Please provide a valid bearer token for authorized API calls. Note that you might need to clear your browser cache if you tried un-authenticated calls before.

Type: apiKey
In: header

Examples

HarvestData_Get

Sample request

HTTP

GET {endpoint}/parties/PARTY123/harvest-data/HARVESTOP123?api-version=2023-11-01-preview

Sample response

Status code:: 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",
  "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
  },
  "createdDateTime": "2021-04-21T06:49:30Z",
  "modifiedDateTime": "2021-04-21T06:49:30Z",
  "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000"
}

Definitions

Name	Description
Error	An error from the Azure AgPlatform service.
ErrorResponse	An error response from the Azure AgPlatform service. See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses for ErrorResponse reference document.
FarmHierarchyGeoResourceType	Resource Type.
GeoJsonObjectType	GeoJSON object type.
GeoResource	Schema for storing resource type and resource id.
HarvestData	Schema of harvest data resource.
HarvestProductDetail	Schema of product used during harvesting.
InnerError	Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document.
Measure	Schema for storing measurement reading and unit.
MultiPolygon	MultiPolygon geometry.
Point	Point geometry.
Polygon	Polygon geometry.

Error

Object

An error from the Azure AgPlatform service.

Name	Type	Description
code	string minLength: 1	Server-defined set of error codes.
details	Error[]	Array of details about specific errors that led to this reported error.
innererror	InnerError	Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document.
message	string minLength: 1	Human-readable representation of the error.
target	string	Target of the error.

ErrorResponse

Object

An error response from the Azure AgPlatform service. See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses for ErrorResponse reference document.

Name	Type	Description
error	Error	An error from the Azure AgPlatform service.
traceId	string	Unique trace Id.

FarmHierarchyGeoResourceType

Enumeration

Resource Type.

Value	Description
Field
SeasonalField
Zone
Prescription
PlantTissueAnalysis
PlantingData
ApplicationData
HarvestData
TillageData

GeoJsonObjectType

Enumeration

GeoJSON object type.

Value	Description
Point
Polygon
MultiPolygon

GeoResource

Object

Schema for storing resource type and resource id.

Name	Type	Description
id	string	Resource Id.
type	FarmHierarchyGeoResourceType	Resource Type.

HarvestData

Object

Schema of harvest data resource.

Name	Type	Description
area	Measure	Schema for storing measurement reading and unit.
associatedResource	GeoResource	Schema for storing resource type and resource id.
avgMoisture	Measure	Schema for storing measurement reading and unit.
avgSpeed	Measure	Schema for storing measurement reading and unit.
avgWetMass	Measure	Schema for storing measurement reading and unit.
avgYield	Measure	Schema for storing measurement reading and unit.
createdBy	string	Created by user/tenant id.
createdDateTime	string (date-time)	Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.
description	string minLength: 0 maxLength: 500	Textual description of the resource.
eTag	string	The ETag value to implement optimistic concurrency.
geometry	GeoJsonObject: MultiPolygon Point Polygon	GeoJSON (For more details: https://geojson.org/). Note: Coordinates are expected in [Longitude, Latitude] format.
harvestProductDetails	HarvestProductDetail[]	Harvest product details.
id	string	Unique resource ID.
modifiedBy	string	Modified by user/tenant id.
modifiedDateTime	string (date-time)	Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.
name	string minLength: 0 maxLength: 100	Name to identify resource.
operationEndDateTime	string (date-time)	End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.
operationModifiedDateTime	string (date-time)	Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. Note: this will be specified by the source provider itself.
operationStartDateTime	string (date-time)	Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.
partyId	string	Party ID which belongs to the operation data.
properties		A collection of key value pairs that belongs to the resource. Each pair must not have a key greater than 50 characters and must not have a value greater than 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.
source	string minLength: 2 maxLength: 100	Source of the resource.
status	string minLength: 0 maxLength: 100	Status of the resource.
totalWetMass	Measure	Schema for storing measurement reading and unit.
totalYield	Measure	Schema for storing measurement reading and unit.

HarvestProductDetail

Object

Schema of product used during harvesting.

Name	Type	Description
area	Measure	Schema for storing measurement reading and unit.
avgMoisture	Measure	Schema for storing measurement reading and unit.
avgWetMass	Measure	Schema for storing measurement reading and unit.
avgYield	Measure	Schema for storing measurement reading and unit.
productName	string minLength: 1 maxLength: 100	Name of the product.
totalWetMass	Measure	Schema for storing measurement reading and unit.
totalYield	Measure	Schema for storing measurement reading and unit.

InnerError

Object

Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document.

Name	Type	Description
code	string	Specific error code than was provided by the containing error.
innererror	InnerError	Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document.

Measure

Object

Schema for storing measurement reading and unit.

Name	Type	Description
unit	string minLength: 1 maxLength: 50	Data unit.
value	number (double)	Data value.

MultiPolygon

Object

MultiPolygon geometry.

Name	Type	Description
coordinates	number[] (double)	Gets or sets Coordinates of GeoJSON Object. It must be an array of polygons, each polygon contains list of linear rings. For Polygons with more than one of these rings, the first MUST be the exterior ring, and any others MUST be interior rings.
type	string: MultiPolygon	GeoJSON object type.

Point

Object

Point geometry.

Name	Type	Description
coordinates	number[] (double)	Gets or sets the coordinate of this point. It must be an array of 2 or 3 elements for a 2D or 3D system.
type	string: Point	GeoJSON object type.

Polygon

Object

Polygon geometry.

Name	Type	Description
coordinates	number[] (double)	Gets or sets type of the GeoJSON Object. It must be an array of linear ring coordinate arrays. For Polygons with more than one of these rings, the first MUST be the exterior ring, and any others MUST be interior rings.
type	string: Polygon	GeoJSON object type.

Share via

Harvest Data - Get

URI Parameters

Request Header

Responses

Security

Authorization

Examples

HarvestData_Get

Sample request

Sample response

Definitions

Error

ErrorResponse

FarmHierarchyGeoResourceType

GeoJsonObjectType

GeoResource

HarvestData

HarvestProductDetail

InnerError

Measure

MultiPolygon

Point

Polygon