xarvio Field Manager Public API (0.1.207)

Download OpenAPI specification:Download

Farm

A farm groups a collection of fields into one business operation.

Create a farm

Authorizations:

OAuth2

Request Body schema: application/json

name required	string [ 2 .. 100 ] characters
timezone	string <timezone> IANA timezone names, https://www.iana.org/time-zones
latitude	number <double> [ -90 .. 90 ] latitude of farm
longitude	number <double> [ -180 .. 180 ] longitude of farm
legalCode	string or null <= 256 characters legalCode of farm
legalEntityName	string or null Farm legal entity name
lastUpdated	string <date-time> Timestamp when farm information was updated last time
	object or null Constitutes billing address of farm
	object or null Constitutes shipping address of farm
growerUuid	string or null <uuid> uuid of a Grower (Collaborator) which is associated with the farm
specialisedUsageType required	string Enum: "FARM" "ORCHARD" "VINEYARD" Specialised usage type of the farm

Responses

Request samples

Payload

Content type

application/json

{"name": "Test farm",
"timezone": "Europe/Berlin",
"latitude": 50.1248458,
"longitude": 8.6147243,
"legalCode": "AT903773497",
"legalEntityName": "UH Farm",
"lastUpdated": "2019-04-03T16:42:23Z",
"billingAddress": {"street": "ABS Street",
"provinceId": "13243",
"countryId": "DE",
"city": "Langenfeld",
"postCode": "40764"
},
"shippingAddress": {"street": "ABS Street",
"provinceId": "13243",
"countryId": "DE",
"city": "Langenfeld",
"postCode": "40764"
},
"growerUuid": "4dfc2bed-21f4-490e-acf1-d0cebafb7185",
"specialisedUsageType": "FARM"
}

Response samples

201
400

Content type

application/json

{"uuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"creatorId": "2a84e0311341c5ebef80",
"lastModifierId": "e7dac807da134b05b58933df9df5ef44",
"etag": "\"1\"",
"name": "Test farm",
"ownerId": "2a84e0311341c5ebef80",
"timezone": "Europe/Berlin",
"latitude": 50.1248458,
"longitude": 8.6147243,
"legalCode": "AT903773497",
"legalEntityName": "UH Farm",
"lastUpdated": "2019-04-03T16:42:23Z",
"billingAddress": {"street": "ABS Street",
"provinceId": "13243",
"countryId": "DE",
"city": "Langenfeld",
"postCode": "40764"
},
"shippingAddress": {"street": "ABS Street",
"provinceId": "13243",
"countryId": "DE",
"city": "Langenfeld",
"postCode": "40764"
},
"growerUuid": "4dfc2bed-21f4-490e-acf1-d0cebafb7185",
"tenantUuid": "4dfc2bed-21f4-490e-acf1-d0cebafb7185",
"specialisedUsageType": "FARM",
"countrySubDivision": "DE-NW",
"countrySecondLevelSubDivision": "FR-NW"
}

Retrieve all accessible farms

Authorizations:

OAuth2

query Parameters

uuid	Array of strings <uuid> Example: uuid=199067a9-5bb1-4f20-9641-a35d5ce31e19 Filter by resource uuid
lastUpdatedFrom	string <date-time> Example: lastUpdatedFrom=2019-04-03T16:42:23Z Optional. Filter by farms lastUpdated property, only farms which were updated after or at the given timestamp will be returned

Responses

Response samples

200
400

Content type

application/json

[{"uuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"creatorId": "2a84e0311341c5ebef80",
"lastModifierId": "e7dac807da134b05b58933df9df5ef44",
"etag": "\"1\"",
"name": "Test farm",
"ownerId": "2a84e0311341c5ebef80",
"timezone": "Europe/Berlin",
"latitude": 50.1248458,
"longitude": 8.6147243,
"legalCode": "AT903773497",
"legalEntityName": "UH Farm",
"lastUpdated": "2019-04-03T16:42:23Z",
"billingAddress": {"street": "ABS Street",
"provinceId": "13243",
"countryId": "DE",
"city": "Langenfeld",
"postCode": "40764"
},
"shippingAddress": {"street": "ABS Street",
"provinceId": "13243",
"countryId": "DE",
"city": "Langenfeld",
"postCode": "40764"
},
"growerUuid": "4dfc2bed-21f4-490e-acf1-d0cebafb7185",
"tenantUuid": "4dfc2bed-21f4-490e-acf1-d0cebafb7185",
"specialisedUsageType": "FARM",
"countrySubDivision": "DE-NW",
"countrySecondLevelSubDivision": "FR-NW"
}
]

Get single farm

Authorizations:

OAuth2

path Parameters

uuid

required

string <uuid>

Example: 199067a9-5bb1-4f20-9641-a35d5ce31e19

Define resource by uuid

header Parameters

If-None-Match

string

Example: "1"

ETag of the resource to fetch. If the resource is unchanged on the server it will respond with 304 Not Modified

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag

Responses

Response samples

200
400

Content type

application/json

{"uuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"creatorId": "2a84e0311341c5ebef80",
"lastModifierId": "e7dac807da134b05b58933df9df5ef44",
"etag": "\"1\"",
"name": "Test farm",
"ownerId": "2a84e0311341c5ebef80",
"timezone": "Europe/Berlin",
"latitude": 50.1248458,
"longitude": 8.6147243,
"legalCode": "AT903773497",
"legalEntityName": "UH Farm",
"lastUpdated": "2019-04-03T16:42:23Z",
"billingAddress": {"street": "ABS Street",
"provinceId": "13243",
"countryId": "DE",
"city": "Langenfeld",
"postCode": "40764"
},
"shippingAddress": {"street": "ABS Street",
"provinceId": "13243",
"countryId": "DE",
"city": "Langenfeld",
"postCode": "40764"
},
"growerUuid": "4dfc2bed-21f4-490e-acf1-d0cebafb7185",
"tenantUuid": "4dfc2bed-21f4-490e-acf1-d0cebafb7185",
"specialisedUsageType": "FARM",
"countrySubDivision": "DE-NW",
"countrySecondLevelSubDivision": "FR-NW"
}

Update a farm

Authorizations:

OAuth2

path Parameters

uuid

required

string <uuid>

Example: 199067a9-5bb1-4f20-9641-a35d5ce31e19

Define resource by uuid

header Parameters

If-Match

required

string

Example: "1"

ETag of the resource to update.

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag

Request Body schema: application/merge-patch+json

name	string [ 2 .. 100 ] characters
timezone	string <timezone> IANA timezone names, https://www.iana.org/time-zones
latitude	number <double> [ -90 .. 90 ] latitude of farm
longitude	number <double> [ -180 .. 180 ] longitude of farm
legalCode	string or null <= 256 characters legalCode of farm
legalEntityName	string or null Farm legal entity name
lastUpdated	string <date-time> Timestamp when farm information was updated last time
	object or null Constitutes billing address of farm
	object or null Constitutes shipping address of farm
growerUuid	string or null <uuid> uuid of a Grower (Collaborator) which is associated with the farm

Responses

Request samples

Payload

Content type

application/merge-patch+json

{"name": "Test farm",
"timezone": "Europe/Berlin",
"latitude": 50.1248458,
"longitude": 8.6147243,
"legalCode": "AT903773497",
"legalEntityName": "UH Farm",
"lastUpdated": "2019-04-03T16:42:23Z",
"billingAddress": {"street": "ABS Street",
"provinceId": "13243",
"countryId": "DE",
"city": "Langenfeld",
"postCode": "40764"
},
"shippingAddress": {"street": "ABS Street",
"provinceId": "13243",
"countryId": "DE",
"city": "Langenfeld",
"postCode": "40764"
},
"growerUuid": "4dfc2bed-21f4-490e-acf1-d0cebafb7185",
"specialisedUsageType": "FARM"
}

Response samples

200
400
412
428

Content type

application/json

{"uuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"creatorId": "2a84e0311341c5ebef80",
"lastModifierId": "e7dac807da134b05b58933df9df5ef44",
"etag": "\"1\"",
"name": "Test farm",
"ownerId": "2a84e0311341c5ebef80",
"timezone": "Europe/Berlin",
"latitude": 50.1248458,
"longitude": 8.6147243,
"legalCode": "AT903773497",
"legalEntityName": "UH Farm",
"lastUpdated": "2019-04-03T16:42:23Z",
"billingAddress": {"street": "ABS Street",
"provinceId": "13243",
"countryId": "DE",
"city": "Langenfeld",
"postCode": "40764"
},
"shippingAddress": {"street": "ABS Street",
"provinceId": "13243",
"countryId": "DE",
"city": "Langenfeld",
"postCode": "40764"
},
"growerUuid": "4dfc2bed-21f4-490e-acf1-d0cebafb7185",
"tenantUuid": "4dfc2bed-21f4-490e-acf1-d0cebafb7185",
"specialisedUsageType": "FARM",
"countrySubDivision": "DE-NW",
"countrySecondLevelSubDivision": "FR-NW"
}

Delete a farm

Authorizations:

OAuth2

path Parameters

uuid

required

string <uuid>

Example: 199067a9-5bb1-4f20-9641-a35d5ce31e19

Define resource by uuid

Responses

Response samples

400

Content type

application/json

{"errorCode": "string",
"statusCode": 400,
"messages": ["string"
],
"timestamp": 0,
"traceId": "string"
}

Retrieves all accessible farms with pagination

Retrieves farms for the specified filter with pagination support.

Authorizations:

OAuth2

query Parameters

page	integer >= 0 Default: 0 Example: page=1 target page of the paginated results
size	integer >= 1 Default: 20 Example: size=10 target page size of the paginated results
uuid	Array of strings <uuid> Example: uuid=199067a9-5bb1-4f20-9641-a35d5ce31e19 Filter by resource uuid
lastUpdatedFrom	string <date-time> Example: lastUpdatedFrom=2019-04-03T16:42:23Z Optional. Filter by farms lastUpdated property, only farms which were updated after or at the given timestamp will be returned

Responses

Response samples

200
400

Content type

application/json

{"content": [{"uuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"creatorId": "2a84e0311341c5ebef80",
"lastModifierId": "e7dac807da134b05b58933df9df5ef44",
"etag": "\"1\"",
"name": "Test farm",
"ownerId": "2a84e0311341c5ebef80",
"timezone": "Europe/Berlin",
"latitude": 50.1248458,
"longitude": 8.6147243,
"legalCode": "AT903773497",
"legalEntityName": "UH Farm",
"lastUpdated": "2019-04-03T16:42:23Z",
"billingAddress": {"street": "ABS Street",
"provinceId": "13243",
"countryId": "DE",
"city": "Langenfeld",
"postCode": "40764"
},
"shippingAddress": {"street": "ABS Street",
"provinceId": "13243",
"countryId": "DE",
"city": "Langenfeld",
"postCode": "40764"
},
"growerUuid": "4dfc2bed-21f4-490e-acf1-d0cebafb7185",
"tenantUuid": "4dfc2bed-21f4-490e-acf1-d0cebafb7185",
"specialisedUsageType": "FARM",
"countrySubDivision": "DE-NW",
"countrySecondLevelSubDivision": "FR-NW"
}
],
"number": 1,
"size": 10,
"totalPages": 2,
"totalElements": 15,
"numberOfElements": 8
}

Field

A field defines a geographical area which is treated as one unit during agricultural production.

Create a field

Authorizations:

OAuth2

Request Body schema: application/json

farmUuid required	string <uuid> Reference to the farm the field belongs to
name required	string [ 1 .. 256 ] characters
required	object (MultiPolygon) Geojson geometry https://tools.ietf.org/html/rfc7946#section-3.1.7
soilTextureUuid	string <uuid> Reference to the field's soil texture, if available; See `/api/md2/soil-textures` API resource documentation.
soilTaxonomyUuid	string <uuid> Reference to the field's soil taxonomy, if available; See `/api/md2/soil-taxonomies` API resource documenatation.
landUseTypeUuid	string or null <uuid> This data is to be recorded at the field level and will enable selection between required type of land.
localSoilScale	string or null Local Soil texture code from MD Configurations
localSoilTextureUuid	string or null <uuid> Local Soil texture uuid from MD Configurations
lastUpdated	string <date-time> Timestamp when field information was updated last time
tags	Array of strings Tags associated to field
centerLatitude	number <double> Latitude of the center of the field. Must be between -85.0511 and 85.0511. Mandatory when `boundary` is null.
centerLongitude	number <double> Longitude of the center of the field. Must be between -179.999999 and 179.999999. Mandatory when `boundary` is null.
soilOrganicMatterPercentage	number or null <double> [ 0 .. 100 ] Soil organic matter percentage of the field
clayPercentage	number or null <double> [ 0 .. 100 ] clay percentage of the field
isInRedZone	boolean or null Indicates whether the field is in a high-risk area requiring immediate attention.
schlagnummer	string or null Schlagnummer or field number, a unique identifier in a farm. Only applicable for Germany.
flik	string or null Flik or block number, can be over one or multiple fields. Only applicable for Germany.
porosityLevelUuid	string <uuid> UUID of soil porosity level. Refer API - `md2/dictionaries?dict = SOILPOROSITY`
soilSalinity	number or null <double> [ 0 .. 18 ] The primary SI unit for measuring soil salinity is electrical conductivity (EC), expressed in deciSiemens per metre (dS/m). This value represents the ECe (electrical conductivity of the soil saturation extract).

Responses

Request samples

Payload

Content type

application/json

{"farmUuid": "string",
"name": "Test farm",
"boundary": {"type": "MultiPolygon",
"coordinates": [[[[102,
2
],
[103,
2
],
[103,
3
],
[102,
3
],
[102,
2
]
]
],
[[[100,
0
],
[101,
0
],
[101,
1
],
[100,
1
],
[100,
0
]
],
[[100.2,
0.2
],
[100.2,
0.8
],
[100.8,
0.8
],
[100.8,
0.2
],
[100.2,
0.2
]
]
]
]
},
"soilTextureUuid": "35e23271-2f68-4a42-99fe-811451e7d1d1",
"soilTaxonomyUuid": "c59dab1d-e6b8-4258-a073-5e7590761769",
"landUseTypeUuid": "87g23271-2f68-4a42-99fe-811451e7d1d1",
"localSoilScale": "USDA",
"localSoilTextureUuid": "c59dab1d-e6b8-4258-a073-5e7590761769",
"lastUpdated": "2019-04-03T16:42:23Z",
"tags": ["GROWER"
],
"centerLatitude": 45.123456,
"centerLongitude": 23.123456,
"soilOrganicMatterPercentage": 85.2,
"clayPercentage": 15.2,
"isInRedZone": true,
"schlagnummer": "123456789",
"flik": "123456789",
"porosityLevelUuid": "7c1175f7-4008-4dbb-97e7-3e41aa1a8f8a",
"soilSalinity": 0.8
}

Response samples

201
400

Content type

application/json

{"uuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"creatorId": "e7dac807da134b05b58933df9df5ef44",
"lastModifierId": "e7dac807da134b05b58933df9df5ef44",
"etag": "\"1\"",
"name": "Test farm",
"area": 38342,
"farmUuid": "4dfc2bed-21f4-490e-acf1-d0cebafb7185",
"boundary": {"type": "MultiPolygon",
"coordinates": [[[[102,
2
],
[103,
2
],
[103,
3
],
[102,
3
],
[102,
2
]
]
],
[[[100,
0
],
[101,
0
],
[101,
1
],
[100,
1
],
[100,
0
]
],
[[100.2,
0.2
],
[100.2,
0.8
],
[100.8,
0.8
],
[100.8,
0.2
],
[100.2,
0.2
]
]
]
]
},
"boundarySvg": "string",
"boundaryChecksum": "48caffab77a67f0f9c485d330ce34a85462a50a2517e9ab0b5e3272d7b9d6355",
"soilTextureUuid": "35e23271-2f68-4a42-99fe-811451e7d1d1",
"soilTaxonomyUuid": "c59dab1d-e6b8-4258-a073-5e7590761769",
"validityScore": 60.02,
"landUseTypeUuid": "87g23271-2f68-4a42-99fe-811451e7d1d1",
"localSoilScale": "USDA",
"localSoilTextureUuid": "c59dab1d-e6b8-4258-a073-5e7590761769",
"lastUpdated": "2019-04-03T16:42:23Z",
"tags": ["GROWER"
],
"centerLatitude": 45.123456,
"centerLongitude": 23.123456,
"soilOrganicMatterPercentage": 85.2,
"clayPercentage": 15.2,
"isInRedZone": true,
"schlagnummer": "123456789",
"flik": "123456789",
"porosityLevelUuid": "7c1175f7-4008-4dbb-97e7-3e41aa1a8f8a",
"soilSalinity": 0.8
}

Read accessible fields

Either uuid or farmUuid filter is required.

Authorizations:

OAuth2

query Parameters

uuid	Array of strings <uuid> Example: uuid=199067a9-5bb1-4f20-9641-a35d5ce31e19 Filter by resource uuid
farmUuid	Array of strings <uuid> Example: farmUuid=199067a9-5bb1-4f20-9641-a35d5ce31e19 Filter by farm uuid
lastUpdatedFrom	string <date-time> Example: lastUpdatedFrom=2019-04-03T16:42:23Z Optional. Filter by fields lastUpdated property, only fields which were updated after or at the given timestamp will be returned

Responses

Response samples

200
400

Content type

application/json

[{"uuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"creatorId": "e7dac807da134b05b58933df9df5ef44",
"lastModifierId": "e7dac807da134b05b58933df9df5ef44",
"etag": "\"1\"",
"name": "Test farm",
"area": 38342,
"farmUuid": "4dfc2bed-21f4-490e-acf1-d0cebafb7185",
"boundary": {"type": "MultiPolygon",
"coordinates": [[[[102,
2
],
[103,
2
],
[103,
3
],
[102,
3
],
[102,
2
]
]
],
[[[100,
0
],
[101,
0
],
[101,
1
],
[100,
1
],
[100,
0
]
],
[[100.2,
0.2
],
[100.2,
0.8
],
[100.8,
0.8
],
[100.8,
0.2
],
[100.2,
0.2
]
]
]
]
},
"boundarySvg": "string",
"boundaryChecksum": "48caffab77a67f0f9c485d330ce34a85462a50a2517e9ab0b5e3272d7b9d6355",
"soilTextureUuid": "35e23271-2f68-4a42-99fe-811451e7d1d1",
"soilTaxonomyUuid": "c59dab1d-e6b8-4258-a073-5e7590761769",
"validityScore": 60.02,
"landUseTypeUuid": "87g23271-2f68-4a42-99fe-811451e7d1d1",
"localSoilScale": "USDA",
"localSoilTextureUuid": "c59dab1d-e6b8-4258-a073-5e7590761769",
"lastUpdated": "2019-04-03T16:42:23Z",
"tags": ["GROWER"
],
"centerLatitude": 45.123456,
"centerLongitude": 23.123456,
"soilOrganicMatterPercentage": 85.2,
"clayPercentage": 15.2,
"isInRedZone": true,
"schlagnummer": "123456789",
"flik": "123456789",
"porosityLevelUuid": "7c1175f7-4008-4dbb-97e7-3e41aa1a8f8a",
"soilSalinity": 0.8
}
]

Get single field

Authorizations:

OAuth2

path Parameters

uuid

required

string <uuid>

Example: 199067a9-5bb1-4f20-9641-a35d5ce31e19

Define resource by uuid

header Parameters

If-None-Match

string

Example: "1"

ETag of the resource to fetch. If the resource is unchanged on the server it will respond with 304 Not Modified

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag

Responses

Response samples

200
400

Content type

application/json

{"uuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"creatorId": "e7dac807da134b05b58933df9df5ef44",
"lastModifierId": "e7dac807da134b05b58933df9df5ef44",
"etag": "\"1\"",
"name": "Test farm",
"area": 38342,
"farmUuid": "4dfc2bed-21f4-490e-acf1-d0cebafb7185",
"boundary": {"type": "MultiPolygon",
"coordinates": [[[[102,
2
],
[103,
2
],
[103,
3
],
[102,
3
],
[102,
2
]
]
],
[[[100,
0
],
[101,
0
],
[101,
1
],
[100,
1
],
[100,
0
]
],
[[100.2,
0.2
],
[100.2,
0.8
],
[100.8,
0.8
],
[100.8,
0.2
],
[100.2,
0.2
]
]
]
]
},
"boundarySvg": "string",
"boundaryChecksum": "48caffab77a67f0f9c485d330ce34a85462a50a2517e9ab0b5e3272d7b9d6355",
"soilTextureUuid": "35e23271-2f68-4a42-99fe-811451e7d1d1",
"soilTaxonomyUuid": "c59dab1d-e6b8-4258-a073-5e7590761769",
"validityScore": 60.02,
"landUseTypeUuid": "87g23271-2f68-4a42-99fe-811451e7d1d1",
"localSoilScale": "USDA",
"localSoilTextureUuid": "c59dab1d-e6b8-4258-a073-5e7590761769",
"lastUpdated": "2019-04-03T16:42:23Z",
"tags": ["GROWER"
],
"centerLatitude": 45.123456,
"centerLongitude": 23.123456,
"soilOrganicMatterPercentage": 85.2,
"clayPercentage": 15.2,
"isInRedZone": true,
"schlagnummer": "123456789",
"flik": "123456789",
"porosityLevelUuid": "7c1175f7-4008-4dbb-97e7-3e41aa1a8f8a",
"soilSalinity": 0.8
}

Update a field

Field boundary can be updated only by an admin, if a field is associated with a crop season which has an APPROVED HF service request.

Authorizations:

OAuth2

path Parameters

uuid

required

string <uuid>

Example: 199067a9-5bb1-4f20-9641-a35d5ce31e19

Define resource by uuid

header Parameters

If-Match

required

string

Example: "1"

ETag of the resource to update.

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag

Request Body schema: application/merge-patch+json

name	string [ 1 .. 256 ] characters
	object (MultiPolygon) Geojson geometry https://tools.ietf.org/html/rfc7946#section-3.1.7
soilTextureUuid	string <uuid> Reference to the field's soil texture, if available; See `/api/md2/soil-textures` API resource documentation.
soilTaxonomyUuid	string <uuid> Reference to the field's soil taxonomy, if available; See `/api/md2/soil-taxonomies` API resource documenatation.
landUseTypeUuid	string or null <uuid> This data is to be recorded at the field level and will enable selection between required type of land.
localSoilScale	string or null Local Soil texture code from MD Configurations
localSoilTextureUuid	string or null <uuid> Local Soil texture uuid from MD Configurations
lastUpdated	string <date-time> Timestamp when field information was updated last time
tags	Array of strings Tags associated to field
centerLatitude	number <double> Latitude of the center of the field. Must be between -85.0511 and 85.0511. Mandatory when `boundary` is null.
centerLongitude	number <double> Longitude of the center of the field. Must be between -179.999999 and 179.999999. Mandatory when `boundary` is null.
soilOrganicMatterPercentage	number or null <double> [ 0 .. 100 ] Soil organic matter percentage of the field
clayPercentage	number or null <double> [ 0 .. 100 ] clay percentage of the field
isInRedZone	boolean or null Indicates whether the field is in a high-risk area requiring immediate attention.
schlagnummer	string or null Schlagnummer or field number, a unique identifier in a farm. Only applicable for Germany.
flik	string or null Flik or block number, can be over one or multiple fields. Only applicable for Germany.
porosityLevelUuid	string <uuid> UUID of soil porosity level. Refer API - `md2/dictionaries?dict = SOILPOROSITY`
soilSalinity	number or null <double> [ 0 .. 18 ] The primary SI unit for measuring soil salinity is electrical conductivity (EC), expressed in deciSiemens per metre (dS/m). This value represents the ECe (electrical conductivity of the soil saturation extract).

Responses

Request samples

Payload

Content type

application/merge-patch+json

{"name": "Test farm",
"boundary": {"type": "MultiPolygon",
"coordinates": [[[[102,
2
],
[103,
2
],
[103,
3
],
[102,
3
],
[102,
2
]
]
],
[[[100,
0
],
[101,
0
],
[101,
1
],
[100,
1
],
[100,
0
]
],
[[100.2,
0.2
],
[100.2,
0.8
],
[100.8,
0.8
],
[100.8,
0.2
],
[100.2,
0.2
]
]
]
]
},
"soilTextureUuid": "35e23271-2f68-4a42-99fe-811451e7d1d1",
"soilTaxonomyUuid": "c59dab1d-e6b8-4258-a073-5e7590761769",
"landUseTypeUuid": "87g23271-2f68-4a42-99fe-811451e7d1d1",
"localSoilScale": "USDA",
"localSoilTextureUuid": "c59dab1d-e6b8-4258-a073-5e7590761769",
"lastUpdated": "2019-04-03T16:42:23Z",
"tags": ["GROWER"
],
"centerLatitude": 45.123456,
"centerLongitude": 23.123456,
"soilOrganicMatterPercentage": 85.2,
"clayPercentage": 15.2,
"isInRedZone": true,
"schlagnummer": "123456789",
"flik": "123456789",
"porosityLevelUuid": "7c1175f7-4008-4dbb-97e7-3e41aa1a8f8a",
"soilSalinity": 0.8
}

Response samples

200
400
412
428

Content type

application/json

{"uuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"creatorId": "e7dac807da134b05b58933df9df5ef44",
"lastModifierId": "e7dac807da134b05b58933df9df5ef44",
"etag": "\"1\"",
"name": "Test farm",
"area": 38342,
"farmUuid": "4dfc2bed-21f4-490e-acf1-d0cebafb7185",
"boundary": {"type": "MultiPolygon",
"coordinates": [[[[102,
2
],
[103,
2
],
[103,
3
],
[102,
3
],
[102,
2
]
]
],
[[[100,
0
],
[101,
0
],
[101,
1
],
[100,
1
],
[100,
0
]
],
[[100.2,
0.2
],
[100.2,
0.8
],
[100.8,
0.8
],
[100.8,
0.2
],
[100.2,
0.2
]
]
]
]
},
"boundarySvg": "string",
"boundaryChecksum": "48caffab77a67f0f9c485d330ce34a85462a50a2517e9ab0b5e3272d7b9d6355",
"soilTextureUuid": "35e23271-2f68-4a42-99fe-811451e7d1d1",
"soilTaxonomyUuid": "c59dab1d-e6b8-4258-a073-5e7590761769",
"validityScore": 60.02,
"landUseTypeUuid": "87g23271-2f68-4a42-99fe-811451e7d1d1",
"localSoilScale": "USDA",
"localSoilTextureUuid": "c59dab1d-e6b8-4258-a073-5e7590761769",
"lastUpdated": "2019-04-03T16:42:23Z",
"tags": ["GROWER"
],
"centerLatitude": 45.123456,
"centerLongitude": 23.123456,
"soilOrganicMatterPercentage": 85.2,
"clayPercentage": 15.2,
"isInRedZone": true,
"schlagnummer": "123456789",
"flik": "123456789",
"porosityLevelUuid": "7c1175f7-4008-4dbb-97e7-3e41aa1a8f8a",
"soilSalinity": 0.8
}

Delete a field

Authorizations:

OAuth2

path Parameters

uuid

required

string <uuid>

Example: 199067a9-5bb1-4f20-9641-a35d5ce31e19

Define resource by uuid

Responses

Response samples

400

Content type

application/json

{"errorCode": "string",
"statusCode": 400,
"messages": ["string"
],
"timestamp": 0,
"traceId": "string"
}

Get single field boundary Deprecated

DEPRECATED: Use getFieldBoundariesByUuid with a single UUID instead.

Authorizations:

OAuth2

path Parameters

uuid

required

string <uuid>

Example: 199067a9-5bb1-4f20-9641-a35d5ce31e19

Define resource by uuid

query Parameters

format

string or null

Default: "kml"

Enum: "shp" "kml" "svg" "kml-dji"

Define export format of the boundary.

Responses

Response samples

400

Content type

application/json

{"statusCode": 400,
"messages": ["string"
],
"timestamp": 0,
"traceId": "string",
"errorCode": "string"
}

Get field boundaries

Authorizations:

OAuth2

query Parameters

format	string or null Default: "kml" Enum: "shp" "kml" "svg" "kml-dji" Define export format of the boundary.
fileName	string or null Default: "name of field" Define the file name of the exported file.
fieldUuid	Array of strings <uuid> <= 1100 items Example: fieldUuid=73750122-2d91-4554-a28f-db7ebee71c6e Provide fieldUuids to export the boundaries for.

Responses

Response samples

400

Content type

application/json

{"statusCode": 400,
"messages": ["string"
],
"timestamp": 0,
"traceId": "string",
"errorCode": "string"
}

Post field boundaries

Authorizations:

OAuth2

Request Body schema: application/json

uuid required	Array of strings <uuid>
filename	string Define the filename of the exported boundary.

Responses

Request samples

Payload

Content type

application/json

{"uuid": ["3e08077b-4489-4920-bc0a-263951a8a97e"
],
"filename": "field-boundary"
}

Response samples

400

Content type

application/json

{"statusCode": 400,
"messages": ["string"
],
"timestamp": 0,
"traceId": "string",
"errorCode": "string"
}

Crop Season

A crop season represents one season of a particular crop on a particular field from seeding until harvest.

Create a crop season

Authorizations:

OAuth2

Request Body schema: application/json

fieldUuid required	string <uuid> Field the crop season belongs to.
cropUuid required	string <uuid> a standard crop OR a crop mix uuid.
cropEstablishmentMethodCode	string Enum: "TRANSPLANTING" "SPREADING" "DIRECT_SEEDING" "RATOONING" "DIRECT_SEEDING_DRY" "DIRECT_SEEDING_WET" "MYKOS_DRY_DIRECT_SEEDING" If `cropEstablishmentMethodCode` is `Transplanting` then it is mandatory to provide `cropEstablishmentGrowthStageIndex` and `startDate`.
cropEstablishmentGrowthStageIndex	string `cropEstablishmentGrowthStageIndex` is mandatory if `cropEstablishmentMethodCode` is `Transplanting`
	object or null constitutes the cover crop mix details, only applicable for cover crop season.
isAutoGenerated	boolean Indicate that, whether the crop season has been auto-generated or not (In case of historical crop season this property will be false).
varietyUuid required	string <uuid>
cropUsageUuid	string <uuid>
tillageUuid	string <uuid>
preCropUuid	string <uuid>
startDate required	string <date-time>
endDate	string <date-time>
yieldExpectation required	number <double> >= 0 Yield expectation in kg/m^2
yield	number <double> >= 0 Actual yield in kg/m^2. `yield` is required if the `endDate` is set.
cropEstablishmentGrowthStageScaleCode	string Enum: "BBCH" "ISU" "ZADOKS" "VBFC" "HORTA_TRZDW_GS" "ISU_LENTIL" "ISU_PEA" "HORTA_GRAPE_NUTRITION" "HORTA_WHEAT_NUTRITION" Growth stage scales are defined in MD2 (used in filter to GET /api/md2/buffer-zone-distances)
seedTreatmentUuid	string <uuid> Deprecated Deprecated. Used only for Japan, use `Seed Treatment Task` instead
rowWidth	number <double> >= 0 Row width in meters.
residueLeft	boolean or null This attribute is to determine whether during harvest residue was left on the field. This can only be set when closing the CS or for closed CSs, i.e. endDate must be non-null already or be set as part of the patch.
biomassPerAreaAtTermination	number or null <double> > 0 Unit of measurement is kg/m2. Determines total land quantifying carbon capture and is supported only for cover crops.
foreignCropUuid	string or null <uuid> User selection of current crop. Refer API - md2/dictionaries?dict = FOREIGNCROP_DE_NUTRITION
foreignPreCropUuid	string or null <uuid> User selection of previous year main crop. Refer API - md2/dictionaries?dict = FOREIGNPRECROP_DE_NUTRITION
foreignCatchCropUuid	string or null <uuid> User selection of catch crop. Refer API - md2/dictionaries?dict = FOREIGNCATCHCROP_DE_NUTRITION
useOrganicFertilizer	boolean or null Optional attribute to determine whether organic fertilizer products can be considered for calculations / recommendations on the crop season
campaignYear	number or null <integer> The campaign year for the crop season
isOrganicFarming	boolean or null Deprecated Deprecated. Use `croppingSystemUuid` attribute instead. Optional attribute to indicate whether cropSeason is linked to organic farming or not.
croppingSystemUuid	string or null <uuid> Cropping system used - UUID, masterdata-dictionary with dict=CROPPINGSYSTEM Currently next cropping systems are supported: `ORG` (ORGANIC), ORGANIC cropping system is to be used as a replacement for `isOrganicFarming` attribute. `CONV` (CONVENTIONAL) `IPM` (IPM)
seedingTillageSystemUuid	string <uuid> Sowing method used - uuid , masterdata-dictionary with dict=TILLAGESYSTEM
groundWaterDepth	number or null <float> Ground water depth in meters
initialWaterContentInSoil	number or null <float> [ 0 .. 100 ] Initial soil water content (%)
depthOfRoots	number or null <float> Root depth in meters
underSeedManagementUuid	string or null <uuid> Turfgrass management UUID from master-data (Applicable for grapes only).
trainingSystemUuid	string or null <uuid> Training system UUID from master-data (Applicable for grapes only).
averageHeightOfCanopy	number or null <float> Canopy height in meters.
averageThicknessOfCanopy	number or null <float> Canopy thickness in meters.

Responses

Request samples

Payload

Content type

application/json

{"fieldUuid": "ec8a3e6e-30ec-41b3-a007-adf2d87dc296",
"cropUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"cropEstablishmentMethodCode": "TRANSPLANTING",
"cropEstablishmentGrowthStageIndex": "05",
"cropMix": null,
"isAutoGenerated": true,
"varietyUuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"cropUsageUuid": "7c1175f7-4008-4dbb-97e7-3e41aa1a8f8a",
"tillageUuid": "1a84e031-c5c6-4fcf-95f6-1341c5ebef85",
"preCropUuid": "4dfc2bed-21f4-490e-acf1-d0cebafb7185",
"startDate": "2019-04-03T16:42:23Z",
"endDate": "2019-04-03T16:42:23Z",
"yieldExpectation": 48,
"yield": 14,
"cropEstablishmentGrowthStageScaleCode": "BBCH",
"seedTreatmentUuid": "4dfc2bed-21f4-490e-acf1-d0cebafb7185",
"rowWidth": 0.7,
"residueLeft": true,
"biomassPerAreaAtTermination": 14.2,
"foreignCropUuid": "4dfc2bed-21f4-490e-acf1-d0cebafb7185",
"foreignPreCropUuid": "5dfc2bed-21f4-490e-acf1-d0cebafb7185",
"foreignCatchCropUuid": "6dfc2bed-21f4-490e-acf1-d0cebafb7185",
"useOrganicFertilizer": true,
"campaignYear": 2024,
"isOrganicFarming": true,
"croppingSystemUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"seedingTillageSystemUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"groundWaterDepth": 2.5,
"initialWaterContentInSoil": 45,
"depthOfRoots": 1.2,
"underSeedManagementUuid": "550e8400-e29b-41d4-a716-446655440000",
"trainingSystemUuid": "123e4567-e89b-12d3-a456-426614174000",
"averageHeightOfCanopy": 1.8,
"averageThicknessOfCanopy": 0.5
}

Response samples

201
400

Content type

application/json

{"uuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"creatorId": "e7dac807da134b05b58933df9df5ef44",
"lastModifierId": "e7dac807da134b05b58933df9df5ef44",
"etag": "\"1\"",
"cropUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"varietyUuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"cropUsageUuid": "7c1175f7-4008-4dbb-97e7-3e41aa1a8f8a",
"tillageUuid": "1a84e031-c5c6-4fcf-95f6-1341c5ebef85",
"preCropUuid": "4dfc2bed-21f4-490e-acf1-d0cebafb7185",
"fieldUuid": "ec8a3e6e-30ec-41b3-a007-adf2d87dcac296",
"area": 34.23,
"lifecycleState": "PLANNED",
"startDate": "2019-04-03T16:42:23Z",
"endDate": "2019-04-03T16:42:23Z",
"yieldExpectation": 48,
"yield": 14,
"boundary": {"type": "MultiPolygon",
"coordinates": [[[[102,
2
],
[103,
2
],
[103,
3
],
[102,
3
],
[102,
2
]
]
],
[[[100,
0
],
[101,
0
],
[101,
1
],
[100,
1
],
[100,
0
]
],
[[100.2,
0.2
],
[100.2,
0.8
],
[100.8,
0.8
],
[100.8,
0.2
],
[100.2,
0.2
]
]
]
]
},
"boundaryChecksum": "48caffab77a67f0f9c485d330ce34a85462a50a2517e9ab0b5e3272d7b9d6355",
"cropEstablishmentMethodCode": "TRANSPLANTING",
"cropEstablishmentGrowthStageIndex": "05",
"cropEstablishmentGrowthStageScaleCode": "BBCH",
"isHealthyField": true,
"validityScore": 60.02,
"seedTreatmentUuid": "4dfc2bed-21f4-490e-acf1-d0cebafb7185",
"rowWidth": 0.7,
"cropMix": {"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"crops": [{"cropUuid": "e169c611-6478-461b-81e4-c09639bbf143",
"percentage": 2.5,
"varietyUuid": "93365697-33e0-460f-a00e-4a7bdfb0e18c"
}
]
},
"residueLeft": true,
"biomassPerAreaAtTermination": 14.2,
"countryCode": "DE",
"isAutoGenerated": true,
"foreignCropUuid": "4dfc2bed-21f4-490e-acf1-d0cebafb7185",
"foreignPreCropUuid": "5dfc2bed-21f4-490e-acf1-d0cebafb7185",
"foreignCatchCropUuid": "6dfc2bed-21f4-490e-acf1-d0cebafb7185",
"useOrganicFertilizer": true,
"campaignYear": 2024,
"isOrganicFarming": true,
"croppingSystemUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"seedingTillageSystemUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"groundWaterDepth": 2.5,
"initialWaterContentInSoil": 45,
"depthOfRoots": 1.2,
"underSeedManagementUuid": "550e8400-e29b-41d4-a716-446655440000",
"trainingSystemUuid": "123e4567-e89b-12d3-a456-426614174000",
"averageHeightOfCanopy": 1.8,
"averageThicknessOfCanopy": 0.5
}

Read accessible crop-seasons

Either uuid or fieldUuid filter is required.

Authorizations:

OAuth2

query Parameters

uuid	Array of strings <uuid> Example: uuid=199067a9-5bb1-4f20-9641-a35d5ce31e19 Filter by resource uuid
fromDate	string <date-time> Example: fromDate=2019-04-03T16:42:23Z Filter `startDate` to be greater then the `fromDate`
lifecycleState	Array of strings Items Enum: "PLANNED" "ACTIVE" "CLOSED" Filter cropseason by lifecycleState.

Responses

Response samples

200
400

Content type

application/json

[{"uuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"creatorId": "e7dac807da134b05b58933df9df5ef44",
"lastModifierId": "e7dac807da134b05b58933df9df5ef44",
"etag": "\"1\"",
"cropUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"varietyUuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"cropUsageUuid": "7c1175f7-4008-4dbb-97e7-3e41aa1a8f8a",
"tillageUuid": "1a84e031-c5c6-4fcf-95f6-1341c5ebef85",
"preCropUuid": "4dfc2bed-21f4-490e-acf1-d0cebafb7185",
"fieldUuid": "ec8a3e6e-30ec-41b3-a007-adf2d87dcac296",
"area": 34.23,
"lifecycleState": "PLANNED",
"startDate": "2019-04-03T16:42:23Z",
"endDate": "2019-04-03T16:42:23Z",
"yieldExpectation": 48,
"yield": 14,
"boundary": {"type": "MultiPolygon",
"coordinates": [[[[102,
2
],
[103,
2
],
[103,
3
],
[102,
3
],
[102,
2
]
]
],
[[[100,
0
],
[101,
0
],
[101,
1
],
[100,
1
],
[100,
0
]
],
[[100.2,
0.2
],
[100.2,
0.8
],
[100.8,
0.8
],
[100.8,
0.2
],
[100.2,
0.2
]
]
]
]
},
"boundaryChecksum": "48caffab77a67f0f9c485d330ce34a85462a50a2517e9ab0b5e3272d7b9d6355",
"cropEstablishmentMethodCode": "TRANSPLANTING",
"cropEstablishmentGrowthStageIndex": "05",
"cropEstablishmentGrowthStageScaleCode": "BBCH",
"isHealthyField": true,
"validityScore": 60.02,
"seedTreatmentUuid": "4dfc2bed-21f4-490e-acf1-d0cebafb7185",
"rowWidth": 0.7,
"cropMix": {"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"crops": [{"cropUuid": "e169c611-6478-461b-81e4-c09639bbf143",
"percentage": 2.5,
"varietyUuid": "93365697-33e0-460f-a00e-4a7bdfb0e18c"
}
]
},
"residueLeft": true,
"biomassPerAreaAtTermination": 14.2,
"countryCode": "DE",
"isAutoGenerated": true,
"foreignCropUuid": "4dfc2bed-21f4-490e-acf1-d0cebafb7185",
"foreignPreCropUuid": "5dfc2bed-21f4-490e-acf1-d0cebafb7185",
"foreignCatchCropUuid": "6dfc2bed-21f4-490e-acf1-d0cebafb7185",
"useOrganicFertilizer": true,
"campaignYear": 2024,
"isOrganicFarming": true,
"croppingSystemUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"seedingTillageSystemUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"groundWaterDepth": 2.5,
"initialWaterContentInSoil": 45,
"depthOfRoots": 1.2,
"underSeedManagementUuid": "550e8400-e29b-41d4-a716-446655440000",
"trainingSystemUuid": "123e4567-e89b-12d3-a456-426614174000",
"averageHeightOfCanopy": 1.8,
"averageThicknessOfCanopy": 0.5
}
]

Get single crop-season

Authorizations:

OAuth2

path Parameters

uuid

required

string <uuid>

Example: 199067a9-5bb1-4f20-9641-a35d5ce31e19

Define resource by uuid

header Parameters

If-None-Match

string

Example: "1"

ETag of the resource to fetch. If the resource is unchanged on the server it will respond with 304 Not Modified

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag

Responses

Response samples

200
400

Content type

application/json

{"uuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"creatorId": "e7dac807da134b05b58933df9df5ef44",
"lastModifierId": "e7dac807da134b05b58933df9df5ef44",
"etag": "\"1\"",
"cropUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"varietyUuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"cropUsageUuid": "7c1175f7-4008-4dbb-97e7-3e41aa1a8f8a",
"tillageUuid": "1a84e031-c5c6-4fcf-95f6-1341c5ebef85",
"preCropUuid": "4dfc2bed-21f4-490e-acf1-d0cebafb7185",
"fieldUuid": "ec8a3e6e-30ec-41b3-a007-adf2d87dcac296",
"area": 34.23,
"lifecycleState": "PLANNED",
"startDate": "2019-04-03T16:42:23Z",
"endDate": "2019-04-03T16:42:23Z",
"yieldExpectation": 48,
"yield": 14,
"boundary": {"type": "MultiPolygon",
"coordinates": [[[[102,
2
],
[103,
2
],
[103,
3
],
[102,
3
],
[102,
2
]
]
],
[[[100,
0
],
[101,
0
],
[101,
1
],
[100,
1
],
[100,
0
]
],
[[100.2,
0.2
],
[100.2,
0.8
],
[100.8,
0.8
],
[100.8,
0.2
],
[100.2,
0.2
]
]
]
]
},
"boundaryChecksum": "48caffab77a67f0f9c485d330ce34a85462a50a2517e9ab0b5e3272d7b9d6355",
"cropEstablishmentMethodCode": "TRANSPLANTING",
"cropEstablishmentGrowthStageIndex": "05",
"cropEstablishmentGrowthStageScaleCode": "BBCH",
"isHealthyField": true,
"validityScore": 60.02,
"seedTreatmentUuid": "4dfc2bed-21f4-490e-acf1-d0cebafb7185",
"rowWidth": 0.7,
"cropMix": {"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"crops": [{"cropUuid": "e169c611-6478-461b-81e4-c09639bbf143",
"percentage": 2.5,
"varietyUuid": "93365697-33e0-460f-a00e-4a7bdfb0e18c"
}
]
},
"residueLeft": true,
"biomassPerAreaAtTermination": 14.2,
"countryCode": "DE",
"isAutoGenerated": true,
"foreignCropUuid": "4dfc2bed-21f4-490e-acf1-d0cebafb7185",
"foreignPreCropUuid": "5dfc2bed-21f4-490e-acf1-d0cebafb7185",
"foreignCatchCropUuid": "6dfc2bed-21f4-490e-acf1-d0cebafb7185",
"useOrganicFertilizer": true,
"campaignYear": 2024,
"isOrganicFarming": true,
"croppingSystemUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"seedingTillageSystemUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"groundWaterDepth": 2.5,
"initialWaterContentInSoil": 45,
"depthOfRoots": 1.2,
"underSeedManagementUuid": "550e8400-e29b-41d4-a716-446655440000",
"trainingSystemUuid": "123e4567-e89b-12d3-a456-426614174000",
"averageHeightOfCanopy": 1.8,
"averageThicknessOfCanopy": 0.5
}

Update a crop-season

Crop season can be updated only by an admin, if it has an APPROVED HF service request.

Authorizations:

OAuth2

path Parameters

uuid

required

string <uuid>

Example: 199067a9-5bb1-4f20-9641-a35d5ce31e19

Define resource by uuid

header Parameters

If-Match

required

string

Example: "1"

ETag of the resource to update.

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag

Request Body schema: application/merge-patch+json

varietyUuid	string <uuid>
cropUsageUuid	string <uuid>
tillageUuid	string <uuid>
preCropUuid	string <uuid>
startDate	string <date-time>
endDate	string <date-time>
yieldExpectation	number <double> >= 0 Yield expectation in kg/m^2
yield	number <double> >= 0 Actual yield in kg/m^2. `yield` is required if the `endDate` is set.
cropEstablishmentGrowthStageScaleCode	string Enum: "BBCH" "ISU" "ZADOKS" "VBFC" "HORTA_TRZDW_GS" "ISU_LENTIL" "ISU_PEA" "HORTA_GRAPE_NUTRITION" "HORTA_WHEAT_NUTRITION" Growth stage scales are defined in MD2 (used in filter to GET /api/md2/buffer-zone-distances)
seedTreatmentUuid	string <uuid> Deprecated Deprecated. Used only for Japan, use `Seed Treatment Task` instead
rowWidth	number <double> >= 0 Row width in meters.
residueLeft	boolean or null This attribute is to determine whether during harvest residue was left on the field. This can only be set when closing the CS or for closed CSs, i.e. endDate must be non-null already or be set as part of the patch.
biomassPerAreaAtTermination	number or null <double> > 0 Unit of measurement is kg/m2. Determines total land quantifying carbon capture and is supported only for cover crops.
foreignCropUuid	string or null <uuid> User selection of current crop. Refer API - md2/dictionaries?dict = FOREIGNCROP_DE_NUTRITION
foreignPreCropUuid	string or null <uuid> User selection of previous year main crop. Refer API - md2/dictionaries?dict = FOREIGNPRECROP_DE_NUTRITION
foreignCatchCropUuid	string or null <uuid> User selection of catch crop. Refer API - md2/dictionaries?dict = FOREIGNCATCHCROP_DE_NUTRITION
useOrganicFertilizer	boolean or null Optional attribute to determine whether organic fertilizer products can be considered for calculations / recommendations on the crop season
campaignYear	number or null <integer> The campaign year for the crop season
isOrganicFarming	boolean or null Deprecated Deprecated. Use `croppingSystemUuid` attribute instead. Optional attribute to indicate whether cropSeason is linked to organic farming or not.
croppingSystemUuid	string or null <uuid> Cropping system used - UUID, masterdata-dictionary with dict=CROPPINGSYSTEM Currently next cropping systems are supported: `ORG` (ORGANIC), ORGANIC cropping system is to be used as a replacement for `isOrganicFarming` attribute. `CONV` (CONVENTIONAL) `IPM` (IPM)
seedingTillageSystemUuid	string <uuid> Sowing method used - uuid , masterdata-dictionary with dict=TILLAGESYSTEM
groundWaterDepth	number or null <float> Ground water depth in meters
initialWaterContentInSoil	number or null <float> [ 0 .. 100 ] Initial soil water content (%)
depthOfRoots	number or null <float> Root depth in meters
underSeedManagementUuid	string or null <uuid> Turfgrass management UUID from master-data (Applicable for grapes only).
trainingSystemUuid	string or null <uuid> Training system UUID from master-data (Applicable for grapes only).
averageHeightOfCanopy	number or null <float> Canopy height in meters.
averageThicknessOfCanopy	number or null <float> Canopy thickness in meters.

Responses

Request samples

Payload

Content type

application/merge-patch+json

{"varietyUuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"cropUsageUuid": "7c1175f7-4008-4dbb-97e7-3e41aa1a8f8a",
"tillageUuid": "1a84e031-c5c6-4fcf-95f6-1341c5ebef85",
"preCropUuid": "4dfc2bed-21f4-490e-acf1-d0cebafb7185",
"startDate": "2019-04-03T16:42:23Z",
"endDate": "2019-04-03T16:42:23Z",
"yieldExpectation": 48,
"yield": 14,
"cropEstablishmentGrowthStageScaleCode": "BBCH",
"seedTreatmentUuid": "4dfc2bed-21f4-490e-acf1-d0cebafb7185",
"rowWidth": 0.7,
"residueLeft": true,
"biomassPerAreaAtTermination": 14.2,
"foreignCropUuid": "4dfc2bed-21f4-490e-acf1-d0cebafb7185",
"foreignPreCropUuid": "5dfc2bed-21f4-490e-acf1-d0cebafb7185",
"foreignCatchCropUuid": "6dfc2bed-21f4-490e-acf1-d0cebafb7185",
"useOrganicFertilizer": true,
"campaignYear": 2024,
"isOrganicFarming": true,
"croppingSystemUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"seedingTillageSystemUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"groundWaterDepth": 2.5,
"initialWaterContentInSoil": 45,
"depthOfRoots": 1.2,
"underSeedManagementUuid": "550e8400-e29b-41d4-a716-446655440000",
"trainingSystemUuid": "123e4567-e89b-12d3-a456-426614174000",
"averageHeightOfCanopy": 1.8,
"averageThicknessOfCanopy": 0.5
}

Response samples

200
400
412
428

Content type

application/json

{"uuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"creatorId": "e7dac807da134b05b58933df9df5ef44",
"lastModifierId": "e7dac807da134b05b58933df9df5ef44",
"etag": "\"1\"",
"cropUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"varietyUuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"cropUsageUuid": "7c1175f7-4008-4dbb-97e7-3e41aa1a8f8a",
"tillageUuid": "1a84e031-c5c6-4fcf-95f6-1341c5ebef85",
"preCropUuid": "4dfc2bed-21f4-490e-acf1-d0cebafb7185",
"fieldUuid": "ec8a3e6e-30ec-41b3-a007-adf2d87dcac296",
"area": 34.23,
"lifecycleState": "PLANNED",
"startDate": "2019-04-03T16:42:23Z",
"endDate": "2019-04-03T16:42:23Z",
"yieldExpectation": 48,
"yield": 14,
"boundary": {"type": "MultiPolygon",
"coordinates": [[[[102,
2
],
[103,
2
],
[103,
3
],
[102,
3
],
[102,
2
]
]
],
[[[100,
0
],
[101,
0
],
[101,
1
],
[100,
1
],
[100,
0
]
],
[[100.2,
0.2
],
[100.2,
0.8
],
[100.8,
0.8
],
[100.8,
0.2
],
[100.2,
0.2
]
]
]
]
},
"boundaryChecksum": "48caffab77a67f0f9c485d330ce34a85462a50a2517e9ab0b5e3272d7b9d6355",
"cropEstablishmentMethodCode": "TRANSPLANTING",
"cropEstablishmentGrowthStageIndex": "05",
"cropEstablishmentGrowthStageScaleCode": "BBCH",
"isHealthyField": true,
"validityScore": 60.02,
"seedTreatmentUuid": "4dfc2bed-21f4-490e-acf1-d0cebafb7185",
"rowWidth": 0.7,
"cropMix": {"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"crops": [{"cropUuid": "e169c611-6478-461b-81e4-c09639bbf143",
"percentage": 2.5,
"varietyUuid": "93365697-33e0-460f-a00e-4a7bdfb0e18c"
}
]
},
"residueLeft": true,
"biomassPerAreaAtTermination": 14.2,
"countryCode": "DE",
"isAutoGenerated": true,
"foreignCropUuid": "4dfc2bed-21f4-490e-acf1-d0cebafb7185",
"foreignPreCropUuid": "5dfc2bed-21f4-490e-acf1-d0cebafb7185",
"foreignCatchCropUuid": "6dfc2bed-21f4-490e-acf1-d0cebafb7185",
"useOrganicFertilizer": true,
"campaignYear": 2024,
"isOrganicFarming": true,
"croppingSystemUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"seedingTillageSystemUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"groundWaterDepth": 2.5,
"initialWaterContentInSoil": 45,
"depthOfRoots": 1.2,
"underSeedManagementUuid": "550e8400-e29b-41d4-a716-446655440000",
"trainingSystemUuid": "123e4567-e89b-12d3-a456-426614174000",
"averageHeightOfCanopy": 1.8,
"averageThicknessOfCanopy": 0.5
}

Delete a crop-season

Authorizations:

OAuth2

path Parameters

uuid

required

string <uuid>

Example: 199067a9-5bb1-4f20-9641-a35d5ce31e19

Define resource by uuid

Responses

Response samples

400

Content type

application/json

{"errorCode": "string",
"statusCode": 400,
"messages": ["string"
],
"timestamp": 0,
"traceId": "string"
}

Get crop-season boundary

Authorizations:

OAuth2

path Parameters

uuid

required

string <uuid>

Example: 199067a9-5bb1-4f20-9641-a35d5ce31e19

Define resource by uuid

query Parameters

format	string or null Default: "kml" Enum: "shp" "kml" "svg" "kml-dji" Define export format of the boundary.
fileName	string or null Default: "name of field" Define the file name of the exported file.

Responses

Response samples

400

Content type

application/json

{"statusCode": 400,
"messages": ["string"
],
"timestamp": 0,
"traceId": "string",
"errorCode": "string"
}

Users

Handle user activities.

Delete a user

Authorizations:

OAuth2

path Parameters

uuid

required

string

Example: 199067a95bb14f209641a35d5ce31e19

Define user by uuid / userId

Responses

Risk

Individual risk (disease/pest) status for your field.

Get status of individual risks Deprecated

Use Risks (V2) instead

Recipe on how to get risks

Authorizations:

OAuth2

query Parameters

cropSeasonUuid required	Array of strings <uuid> Example: cropSeasonUuid=2a84e031-c5c6-4fcf-95f6-1341c5ebef80 Filter by cropseason uuid
fromDate	string <date-time> Example: fromDate=2021-04-03T12:34:56Z from date, inclusive. A calculation valid-range needs to intersect the range from fromDate(inclusive) and tillDate(exclusive) to match the filter.
tillDate	string <date-time> Example: tillDate=2021-04-03T12:34:56Z till date, exclusive. A calculation valid-range needs to intersect the range from fromDate(inclusive) and tillDate(exclusive) to match the filter.
status	Array of strings or null Items Enum: "HIGH" "MEDIUM_HIGH" "MEDIUM" "MEDIUM_LOW" "LOW" "NO_INFORMATION" "PROTECTED" "INACTIVE" "NOT_RELEVANT" Example: status=HIGH,MEDIUM status
type	Array of strings or null Items Enum: "STRESS_RISK" "STRESS_PRIMARY_RISK" "STRESS_SECONDARY_RISK" "STRESS_COMBINED_PRIMARY_SECONDARY_RISK" "STRESS_CONIDIA_RISK" "STRESS_ASCOSPORES_RISK" "STRESS_COMBINED_CONIDIA_ASCOSPORES_RISK" "STRESS_INFECTION_RISK" "STRESS_MICOTOXIN_RISK" Example: type=STRESS_RISK, STRESS_PRIMARY_RISK type

Responses

Response samples

200
400

Content type

application/json

[{"isStale": false,
"isLocked": false,
"calculationDate": "2019-04-03T07:42:23Z",
"startDate": "2019-04-03T00:00:00Z",
"endDate": "2019-04-04T00:00:00Z",
"uuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"stressUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"status": "HIGH",
"basedOn": "HISTORIC",
"type": "STRESS_RISK",
"statusPrecision": 23.3
}
]

Risks (V2)

Individual risk (disease/pest) status for your field.

Get status of individual risks

Authorizations:

OAuth2

query Parameters

cropSeasonUuid required	Array of strings <uuid> Example: cropSeasonUuid=2a84e031-c5c6-4fcf-95f6-1341c5ebef80 Filter by cropseason uuid
fromDate	string <date-time> Example: fromDate=2021-04-03T12:34:56Z from date, inclusive. A calculation valid-range needs to intersect the range from fromDate(inclusive) and tillDate(exclusive) to match the filter.
tillDate	string <date-time> Example: tillDate=2021-04-03T12:34:56Z till date, exclusive. A calculation valid-range needs to intersect the range from fromDate(inclusive) and tillDate(exclusive) to match the filter.
status	Array of strings or null Items Enum: "HIGH" "MEDIUM_HIGH" "MEDIUM" "MEDIUM_LOW" "LOW" "NO_INFORMATION" "PROTECTED" "INACTIVE" "NOT_RELEVANT" Example: status=HIGH,MEDIUM status
type	Array of strings or null Items Enum: "STRESS_RISK" "STRESS_PRIMARY_RISK" "STRESS_SECONDARY_RISK" "STRESS_COMBINED_PRIMARY_SECONDARY_RISK" "STRESS_CONIDIA_RISK" "STRESS_ASCOSPORES_RISK" "STRESS_COMBINED_CONIDIA_ASCOSPORES_RISK" "STRESS_INFECTION_RISK" "STRESS_MICOTOXIN_RISK" Example: type=STRESS_RISK, STRESS_PRIMARY_RISK type

Responses

Response samples

200
400

Content type

application/json

[{"isStale": false,
"isLocked": false,
"calculationDate": "2019-04-03T07:42:23Z",
"startDate": "2019-04-03T00:00:00Z",
"endDate": "2019-04-04T00:00:00Z",
"cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"stressUuids": ["2a84e031-c5c6-4fcf-95f6-1341c5ebef80"
],
"status": "HIGH",
"basedOn": "HISTORIC",
"type": "STRESS_RISK",
"statusPrecision": 23.3
}
]

Action windows

Action window represents a time frame in which certain operations (spraying, harvesting, etc.) should be performed

Get action windows for a given crop season

Authorizations:

OAuth2

query Parameters

cropSeasonUuid required	Array of strings <uuid> Example: cropSeasonUuid=2a84e031-c5c6-4fcf-95f6-1341c5ebef80 Filter by cropseason uuid
fromDate	string <date-time> Example: fromDate=2021-04-03T12:34:56Z from date, inclusive. A calculation valid-range needs to intersect the range from fromDate(inclusive) and tillDate(exclusive) to match the filter.
tillDate	string <date-time> Example: tillDate=2021-04-03T12:34:56Z till date, exclusive. A calculation valid-range needs to intersect the range from fromDate(inclusive) and tillDate(exclusive) to match the filter.

Responses

Response samples

200
400

Content type

application/json

[{"calculationDate": "2020-10-26T03:06:56.814277Z",
"type": "FUNGICIDE_APPLICATION",
"cropSeasonUuid": "d772e331-ef30-4e9f-b962-da799fbf8428",
"startDate": "2020-10-26T03:00:00Z",
"endDate": "2020-10-27T03:00:00Z",
"windowStartDate": "2020-10-26T03:00:00Z",
"windowEndDate": "2020-10-31T03:00:00Z",
"status": "CURRENT",
"isStale": false,
"isLocked": false
},
{"calculationDate": "2020-10-26T03:06:56.814277Z",
"type": "FUNGICIDE_APPLICATION",
"cropSeasonUuid": "d772e331-ef30-4e9f-b962-da799fbf8428",
"startDate": "2020-10-27T03:00:00Z",
"endDate": "2020-10-28T03:00:00Z",
"windowStartDate": "2020-10-27T03:00:00Z",
"windowEndDate": "2020-10-31T03:00:00Z",
"status": "CURRENT",
"isStale": false,
"isLocked": false
},
{"calculationDate": "2020-10-26T03:06:56.81429Z",
"type": "PLANT_GROWTH_REGULATOR_APPLICATION",
"cropSeasonUuid": "d772e331-ef30-4e9f-b962-da799fbf8428",
"startDate": "2020-10-26T03:00:00Z",
"endDate": "2020-10-27T03:00:00Z",
"status": "NOT_PRESENT",
"isStale": false,
"isLocked": false
},
{"calculationDate": "2020-10-26T03:06:56.81429Z",
"type": "PLANT_GROWTH_REGULATOR_APPLICATION",
"cropSeasonUuid": "d772e331-ef30-4e9f-b962-da799fbf8428",
"startDate": "2020-10-27T03:00:00Z",
"endDate": "2020-10-28T03:00:00Z",
"status": "NOT_PRESENT",
"isStale": false,
"isLocked": false
}
]

Action recommendations

Action recommendation represents a recommendation about what actions should / must be performed for a certain crop season in a given time frame

Get action recommendations for a given crop season for the specified time frame

Authorizations:

OAuth2

query Parameters

cropSeasonUuid required	Array of strings <uuid> Example: cropSeasonUuid=2a84e031-c5c6-4fcf-95f6-1341c5ebef80 Filter by cropseason uuid
fromDate	string <date-time> Example: fromDate=2021-04-03T12:34:56Z from date, inclusive. A calculation valid-range needs to intersect the range from fromDate(inclusive) and tillDate(exclusive) to match the filter.
tillDate	string <date-time> Example: tillDate=2021-04-03T12:34:56Z till date, exclusive. A calculation valid-range needs to intersect the range from fromDate(inclusive) and tillDate(exclusive) to match the filter.

Responses

Response samples

200
400

Content type

application/json

[{"calculationDate": "2020-10-26T03:06:56.814277Z",
"type": "FUNGICIDE_APPLICATION",
"cropSeasonUuid": "d772e331-ef30-4e9f-b962-da799fbf8428",
"startDate": "2020-10-26T03:00:00Z",
"endDate": "2020-10-27T03:00:00Z",
"confidenceLevel": "TREAT",
"status": "RECOMMENDED",
"isStale": false,
"isLocked": false
},
{"calculationDate": "2020-10-26T03:06:56.81428Z",
"type": "FUNGICIDE_APPLICATION",
"cropSeasonUuid": "d772e331-ef30-4e9f-b962-da799fbf8428",
"startDate": "2020-10-27T03:00:00Z",
"endDate": "2020-10-28T03:00:00Z",
"confidenceLevel": "TREAT",
"status": "RECOMMENDED",
"isStale": false,
"isLocked": false
},
{"calculationDate": "2020-10-26T03:06:56.81429Z",
"type": "PLANT_GROWTH_REGULATOR_APPLICATION",
"cropSeasonUuid": "d772e331-ef30-4e9f-b962-da799fbf8428",
"startDate": "2020-10-26T03:00:00Z",
"endDate": "2020-10-27T03:00:00Z",
"status": "NOT_NEEDED",
"isStale": false,
"isLocked": false
},
{"calculationDate": "2020-10-26T03:06:56.814292Z",
"type": "PLANT_GROWTH_REGULATOR_APPLICATION",
"cropSeasonUuid": "d772e331-ef30-4e9f-b962-da799fbf8428",
"startDate": "2020-10-27T03:00:00Z",
"endDate": "2020-10-28T03:00:00Z",
"status": "NOT_NEEDED",
"isStale": false,
"isLocked": false
}
]

Spraying Windows

Read current spraying window information for a crop season

Get current spraying window information for a crop season Deprecated

Authorizations:

OAuth2

query Parameters

cropSeasonUuid

required

Array of strings <uuid>

Example: cropSeasonUuid=2a84e031-c5c6-4fcf-95f6-1341c5ebef80

Filter by cropseason uuid

Responses

Response samples

200
400
404

Content type

application/json

[{"uuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"status": "NOT_PRESENT",
"startDate": "2019-04-03T16:42:23Z",
"endDate": "2019-04-03T16:42:23Z"
}
]

Crop Season Status

Represents the status of a cropseason

Get crop season status

Recipe on how to get crop season status

Authorizations:

OAuth2

query Parameters

cropSeasonUuid required	Array of strings <uuid> Example: cropSeasonUuid=2a84e031-c5c6-4fcf-95f6-1341c5ebef80 Filter by cropseason uuid
fromDate	string <date-time> Example: fromDate=2021-04-03T12:34:56Z from date, inclusive. A calculation valid-range needs to intersect the range from fromDate(inclusive) and tillDate(exclusive) to match the filter.
tillDate	string <date-time> Example: tillDate=2021-04-03T12:34:56Z till date, exclusive. A calculation valid-range needs to intersect the range from fromDate(inclusive) and tillDate(exclusive) to match the filter.
type	Array of strings or null Items Enum: "LODGING" "DISEASE" "INSECT" "ABIOTIC" "WEED" Example: type=LODGING,INSECT Filter crop season status by type

Responses

Response samples

200
400

Content type

application/json

[{"isStale": false,
"isLocked": false,
"calculationDate": "2019-04-03T07:42:23Z",
"startDate": "2019-04-03T00:00:00Z",
"endDate": "2019-04-04T00:00:00Z",
"cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"type": "LODGING",
"status": "HIGH",
"basedOn": "HISTORIC"
}
]

Daily weed risk details

Read daily weed risk details for a crop season

Get daily weed risk details

Authorizations:

OAuth2

query Parameters

cropSeasonUuid required	Array of strings <uuid> Example: cropSeasonUuid=2a84e031-c5c6-4fcf-95f6-1341c5ebef80 Filter by cropseason uuid
fromDate	string <date-time> Example: fromDate=2021-04-03T12:34:56Z from date, inclusive. A calculation valid-range needs to intersect the range from fromDate(inclusive) and tillDate(exclusive) to match the filter.
tillDate	string <date-time> Example: tillDate=2021-04-03T12:34:56Z till date, exclusive. A calculation valid-range needs to intersect the range from fromDate(inclusive) and tillDate(exclusive) to match the filter.

Responses

Response samples

200
400

Content type

application/json

[{"isStale": false,
"isLocked": false,
"calculationDate": "2019-04-03T07:42:23Z",
"startDate": "2019-04-03T00:00:00Z",
"endDate": "2019-04-04T00:00:00Z",
"cropSeasonUuid": "8674267e-c1ef-4d9b-8764-d976d55da2b7",
"stressUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"weedGrowthStageScale": "BBCH",
"weedGrowthStageIndex": "12",
"leafIndexCount": 2.5,
"isLast": false
}
]

Dosed Maps

A dosed map attaches product/water dosage information with the geometry of a crop season, specifying how much to spray where. A dosed map is immutable.

Get dosed maps

Authorizations:

OAuth2

query Parameters

uuid	Array of strings <uuid> Example: uuid=199067a9-5bb1-4f20-9641-a35d5ce31e19 Filter by resource uuid
cropSeasonUuid	Array of strings <uuid> Example: cropSeasonUuid=2a84e031-c5c6-4fcf-95f6-1341c5ebef80 Filter by cropseason uuid
includeComponentRates	boolean Default: false Provide not only the product application rates, but also the rates of all individual components of the tank mix in the response. The correct amounts are fetched on-the-fly from master-data, so please only include if you actually need them.
$extends	Array of strings Items Value: "geometry" Example: $extends=geometry Extends enriches the response with `geometry` geojson property. If not sent `geometry` will be `null` in the response.

Responses

Response samples

200
400

Content type

application/json

[{"uuid": "199067a9-5bb1-4f20-9641-a35d5ce31e19",
"cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"productPackUuids": ["351a457a-c400-446a-85d1-9652f21f56ee"
],
"imageUrl": "https://gis-dev.digital-farming.com/dosed-map/wms?layers=dosed-map%3Adosed_map&viewparams=dosed_map_uuid%3A2e395ad5-6ca3-4d29-938c-5793670b17ba&service=WMS&version=1.1.0&request=GetMap&styles=DOSED_MAP_VRA&bbox=1407098.1896282881%2C6761846.424072453%2C1408010.6754943207%2C6763456.424441723&width=580&height=1024&srs=EPSG%3A3857&format=image%2Fpng8&transparent=true",
"dateCreated": "2019-04-03T16:42:23Z",
"waterAverageApplicationRate": 0.000015926667,
"waterTotalApplication": 0.08477621,
"additives": [{"uuid": "199067a9-5bb1-4f20-9641-a35d5ce31e19",
"rates": [[1.1e-7,
1.0083333e-7,
9.1666664e-8,
8.25e-8,
7.333333e-8
]
]
}
],
"recipeV2": [{"uuid": "b7784b3b-1f9b-bc42-f65d-1cf9f02eaede",
"type": "PRODUCT",
"unit": "KGPM2",
"formulation": "LIQUID",
"averageApplicationRate": 0.000015926667,
"totalApplication": 0.00039,
"ratesPerZone": [[0.000016
]
],
"ratesByZone": [{"id": "1",
"rate": 0.000016,
"componentRates": [{"uuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"type": "NUTRIENT",
"rate": 0.000016
}
],
"localUnitUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"volumeBasisLocalUnitUuid": "bedc4521-6797-4f57-8437-a539c5dea0b1",
"volumeBasisRate": 1.2,
"dilutionFactor": 23.3
}
]
}
],
"rxValues": [[0.000016
]
],
"applicationZones": [{"category": "FLAT",
"area": 5322.9097,
"active": true,
"rate": 0.000016,
"componentRates": [{"uuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"type": "NUTRIENT",
"rate": 0.000016
}
],
"id": 1
}
],
"isHighFlow": true,
"fieldZones": [{"geometry": {"type": "MultiPolygon",
"coordinates": [[[[102,
2
],
[103,
2
],
[103,
3
],
[102,
3
],
[102,
2
]
]
],
[[[100,
0
],
[101,
0
],
[101,
1
],
[100,
1
],
[100,
0
]
],
[[100.2,
0.2
],
[100.2,
0.8
],
[100.8,
0.8
],
[100.8,
0.2
],
[100.2,
0.2
]
]
]
]
},
"type": "TRIAL_PLOT",
"fixedRate": 1.5,
"priority": 0,
"checksum": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
"fieldZoneUuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5"
}
],
"applicationType": "VRA",
"applicationMode": "SPRAYING",
"actionTypes": [["FUNGICIDE_APPLICATION",
"PLANT_GROWTH_REGULATOR_APPLICATION"
]
],
"waterRates": [[0.00002,
0
]
],
"rates": [{"productUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"uuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"type": "PRODUCT",
"unit": "KGPM2",
"isMaster": true,
"rates": [[0.0001,
0
]
],
"localUnitUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"volumeBasisLocalUnitUuid": "bedc4521-6797-4f57-8437-a539c5dea0b1",
"volumeBasisRate": 1.2,
"dilutionFactor": 23.3
}
],
"geometry": "{\"type\":\"FeatureCollection\",\"features\":[{\"type\":\"Feature\",\"geometry\":{\"type\":\"MultiPolygon\",\"coordinates\":[[[[8.2343514082,52.2875129922],[8.2352742683,52.2881572627],[8.2358215457,52.2873420617],[8.2347806454,52.286710928],[8.2343514082,52.2875129922]]]]},\"properties\":{\"id\":\"1\",\"rx\":2.0E-5,\"category\":\"BIODIVERSITY_WINDOW\"},\"id\":\"1\"}]}",
"sourceMapUuid": "a8ff87d1-01b9-4978-8934-97af80907c7c",
"zonePercentageDifferences": [{"zoneId": 3,
"applicationStrategy": "MORE_TO_HIGH",
"rateFactor": 0.5
}
],
"percentageSpread": 5,
"checksum": "06148a3a1816ff76d120748e65a8f805db4041f3d1e099f9f48c92a57f7487cf",
"recommendationDate": "2019-04-03T16:42:23Z",
"doseKeyOverride": "LOW",
"doseKey": "LOW",
"limitedVra": false,
"specificLimitedVra": false,
"overrideSpecificLimitedVra": false,
"masterVraRates": [[0.0001,
0
]
],
"subscriptionStatus": "TOO_SMALL",
"weedPressureThreshold": 0,
"applicationSpotUuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"taskMethodUuid": "0a404a03-a37e-4302-b8a7-33e74e4e0670",
"averageWaterRate": 5e-7,
"averageTargetRate": 1e-7,
"totalTargetAmount": 10000,
"targetNutrientUuid": "fd7cedf4-6a01-49fb-9fd1-1228e70649e7",
"applicationStrategy": "MORE_TO_LOW",
"creationFlowHint": "CROP_PROTECTION",
"applicationDepth": 6.7,
"rowWidth": 6,
"ureaseInhibitorUsed": true,
"nitrificationInhibitorUsed": true,
"overrideVraRestriction": true,
"limitationReasons": ["HIGH_RISK_EYESPOT"
],
"treatmentReasons": [{"stressUuid": "c643d05c-513f-11f0-b874-cb36cedad4d3",
"reasonUuid": "199067a9-5bb1-4f20-9641-a35d5ce31e19"
}
],
"referenceZoneId": ["3"
]
}
]

Create a dosed map

Authorizations:

OAuth2

Request Body schema: application/json

	Array of objects
creationFlowHint	string or null Enum: "WEED_MANAGEMENT" "CROP_PROTECTION" "NUTRITION_MANAGEMENT" "CROP_ESTABLISHMENT" "SMART_SPRAYING" A hint for the task creation flow. It will be always set to 'NUTRITION_MANAGEMENT' for `average-based-vra-dosed-maps` and application modes `SPRAYING` and `SPREADING`. It will be always set to 'CROP_ESTABLISHMENT' for `average-based-vra-dosed-maps` and application mode `SEEDING`.
fieldDataLayerUuid	string <uuid> Required for Nutrition VRA Advisor and Equations Nutrition Task. Referenced FDL contains required for source map geometry.
fieldDataLayerMagnitudeType	string or null Enum: "LAI" "LAI_CONTRAST" "NDVI" "NDVI_CONTRAST" "ZONES" "EVI" "BULK_DENSITY" "CALCIUM_CARBONATE" "CARBON_NITROGEN_RATIO" "CATION_EXCHANGE_CAPACITY" "CLAY_CONTENT" "COPPER_MEHLICH" "COPPER_DTPA" "ELECTRICAL_CONDUCTIVITY" "FINE_EARTH_DENSITY" "IRON_DTPA" "IRON_MEHLICH" "MAGNESIUM" "MANGANESE_DTPA" "MANGANESE_MEHLICH" "NITROGEN_CONTENT_NH4" "NITROGEN_CONTENT_NO3" "ORGANIC_CARBON_CONTENT" "ORGANIC_MATTER" "PH_CACL" "PH_H2O" "PH_KCL" "PHOSPHORUS" "PHOSPHORUS_MEHLICH" "PHOSPHORUS_RESINA" "PHOSPHORUS_OLSEN" "PHOSPHORUS_MEHLICH_BASED_ON_CLAY" "FREE_IRON_OXIDES" "EXCHANGEABLE_CALCIUM" "EXCHANGEABLE_MAGNESIUM" "EXCHANGEABLE_MANGANESE" "EASILY_REDUCING_MANGANESE" "AVAILABLE_NITROGEN" "PHOSPHORUS_BRAY" "PHOSPHORUS_TRUOG" "PHOSPHORUS_ABSORTION_COEFFICIENT" "EXCHANGEABLE_POTASSIUM" "AVAILABLE_SILICON" "HUMUS" "POTASSIUM" "ROCK_FRAGMENTS" "SAND_CONTENT" "SILT_CONTENT" "SULFUR" "TOTAL_KJELDAHL_NITROGEN" "ZINC_MEHLICH" "ZINC_DTPA CALCIUM_SATURATION_IN_CEC" "POTASSIUM_SATURATION_IN_CEC" "MAGNESIUM_SATURATION_IN_CEC" "ALUMINIUM_SATURATION_IN_CEC" "DRONE_FLIGHT_ZONES_NATURAL_BREAKS" "DRONE_FLIGHT_ZONES_EQUAL_INTERVAL" "SURFACE_FRACTION_LOW_SENSITIVITY" "SURFACE_FRACTION_MEDIUM_SENSITIVITY" "SURFACE_FRACTION_HIGH_SENSITIVITY" Indicates the magnitude type of the fieldDataLayer behind the sourceMap to be picked. If `null`, default magnitude type of the fieldDataLayer will be used.
fieldDataLayerProcessingType	string or null Enum: "NONE" "ZONED" "ZONED_FILL_GAPS" "ZONED_BY_AFFECTED_AREA" Indicates the processing type of the magnitude. If `fieldDataLayerMagnitudeType` is `null`, then also `FieldDataLayerProcessingType` is `null`.
fieldDataLayerMinElevation	number Required for Equations Nutrition Task. Referenced min elevation required for source map geometry. If `fieldDataLayerMagnitudeType` is `null`, then also `fieldDataLayerMinElevation` is `null`.
fieldDataLayerMaxElevation	number Required for Equations Nutrition Task. Referenced max elevation required for source map geometry. If `fieldDataLayerMagnitudeType` is `null`, then also `fieldDataLayerMaxElevation` is `null`.
stacItemUuid	string <uuid> Required for Nutrition VRA Advisor. UUID of the raw image item in STAC catalog. It is used as `sourceUuid` value for source maps with source map type `VRA_ADVISOR`.
index	string Enum: "LAI" "BP" "BP_LAI" "POWERZONE_DATA" Required for Nutrition VRA Advisor. Currently supports only `LAI`, `BP`, `BP_LAI` and `POWERZONE_DATA` index type.
cropSeasonUuid required	string <uuid>
productPackUuids	Array of strings <uuid>
isHighFlow required	boolean Flag to determine the factor use to reduce the given flow rate (`rates`), depending on the machinery. Used only for `applicationType` `VRA`, ignored otherwise.
	Array of objects
applicationType required	string Enum: "FLAT" "VRA" "CUSTOM_VRA" "VRA_HERB" "ON_OFF" "VARIABLE_RATE_SEEDING" "FLAT_SEEDING" "SPOT" "AVERAGE_BASED_VRA" "AVERAGE_BASED_VRA_SEEDING" If `VARIABLE_RATE_SEEDING` or `FLAT_SEEDING` `applicationMode` must be `SEEDING` `waterRates` must be null of empty `sourceMapUuid` is mandatory and the referenced source map's zoneCount matches the number of provided `rates` `rates` contains a single element of `type` `VARIETY` Number of zones is from 1 to 7 (depending on the country). If `FLAT` or `FLAT_SEEDING` the dosed map will have 1 zone (applies to `rates`, `additives` and `waterRates` in the request). If `VRA`, `CUSTOM_VRA` the dosed map will have 5 or 7 zones, depending on the country (applies to `rates`, `additives` and `waterRates` in the request). If `AVERAGE_BASED_VRA` the dosed map will have 5 or 7 zones, depending on the country. But only one product without additives can be present in the recipe. Creation of `AVERAGE_BASED_VRA` dosed maps must be done with the specific POST `/average-based-vra-dosed-maps` endpoint, cannot be created with the regular POST `/dosed-maps` endpoint If `AVERAGE_BASED_VRA_SEEDING` the dosed map will have 5 or 7 zones, depending on the country. But only one variety can be present in the recipe. Creation of `AVERAGE_BASED_VRA_SEEDING` dosed maps must be done with the specific POST `/average-based-vra-dosed-maps` endpoint, cannot be created with the regular POST `/dosed-maps` endpoint `applicationMode` must be `SEEDING` `waterRates` must be null of empty If `ON_OFF` the dosed map will have 7 zones with either one rate or 0 (`rates`, `additives` and `waterRates` must have a single element). If `VRA_HERB` the dosed map will have 2 zones (applies to `rates`, `additives` and `waterRates` in the request). If `SPOT` the dosed map will resemble the `FLAT` layout, but signals the usage for specific SPOT spraying devices. `SPOT` only works for application mode `SPRAYING`.
applicationMode	string Enum: "SPRAYING" "SPREADING" "SEEDING" If `SPRAYING`, then `waterRates` must be not null and not empty. `applicationType` cannot be `VARIABLE_RATE_SEEDING` or `FLAT_SEEDING`. If `SPREADING`, then `waterRates` must be null or empty. `applicationType` cannot be `VARIABLE_RATE_SEEDING` or `FLAT_SEEDING`. If `SEEDING`, then `applicationType` can only be `VARIABLE_RATE_SEEDING` or `FLAT_SEEDING`.
waterRates	Array of any or null Application rate of water for each zone, positive numbers in SI units ordered from high to low. As many rates as zones in the `geometry` collection, depending on the `applicationType`. null for average based VRA maps. See `rates` for validation rules in the case of `VRA` `applicationType`.
required	Array of objects Substance rates. For dosed maps with `applicationType` `VRA`, the rates must follow some rules: For each zone `i, i > 0`, the ratio between the rates of i-th zone and first zone (i=0) should be the same across all substances. For each zone `i, i > 0`, the ratio between the rates of i-th zone and (i-1)th zone should never decrease and be between a factor and 1. The factor depends on the `isHighFlow` parameter: `highFlow=true`: 0.917 `highFlow=false`: 0.95 For each zone, the total liquid rate in `waterRates` must be larger than the sum of substance rates in `rates`.
sourceMapUuid	string <uuid> UUID of the source map used for creating the dosed map. It's mandatory for some application types. When optional, the best one (most recent, with better resolution, etc.) will be picked automatically. For `applicationType`, we support sourceMapTypes: `VRA`, `ON_OFF`: `BIOMASS_LAI` `SOIL_SAMPLING_POWERZONE` `BIOMASS_MONITORING_VECTOR_ANALYSIS` `BIOMASS_PROXY_MONITORING_VECTOR_ANALYSIS` `CUSTOM_POWERZONE_LAI` `PLANET_LAI` `BIOMASS_NDVI` `SOIL` `CUSTOM` `CUSTOM_UPLOAD_FDL` `VRA_ADVISOR` `CUSTOM_VRA`: `BIOMASS_LAI` `SOIL_SAMPLING_POWERZONE` `BIOMASS_MONITORING_VECTOR_ANALYSIS` `BIOMASS_PROXY_MONITORING_VECTOR_ANALYSIS` `CUSTOM_POWERZONE_LAI` `PLANET_LAI` `BIOMASS_NDVI` `SOIL` `CUSTOM` `CUSTOM_UPLOAD_FDL` `VRA_ADVISOR` Plus, for `VRA` and `CUSTOM_VRA`: `DRONE_SYNTHETIC `DRONE_VARIGREEN` `DRONE_GLI` `DRONE_NDVI` `DRONE_NDRE`
recommendationDate	string <date-time> Date when the application took/will take place in the field. Used only for `VRA` applications to verify the validity of a variable rate application for that crop and date. If not provided (or VRA is not available for the crop and date), the produced dosed map will be `FLAT`. For other application types will be ignored.
doseKeyOverride	string Deprecated Enum: "LOW" "MEDIUM" "HIGH" Starting on 2020 the VRA logic does not use this anymore
overrideSpecificLimitedVra	boolean Deprecated Starting on 2020 the VRA logic does not use this anymore
weedPressureThreshold	number The threshold to use for for spraying when using `VRA_HERB` applications.
applicationSpotUuid	string <uuid>
taskMethodUuid	string <uuid>
targetNutrientUuid	string <uuid> UUID of the target nutrient. This property is only applicable for `ApplicationType`s `CUSTOM_VRA`, `FLAT` and `AVERAGE_BASED_VRA`. If present, the provided / returned rates & amounts refer to the nutrient in the product. If not present, they refer to the amount of product itself.
applicationDepth	number or null >= 0 This is needed for carbon farming to be able to compute carbon sequestration as this is necessary input information. When `applicationDepth` is given then `taskMethodUuid` should also be provided.
rowWidth	number or null Distance between rows when a product is using units/distance (SEED_MROW). Required in that case.
ureaseInhibitorUsed	boolean or null This is needed for carbon farming to be able to compute carbon sequestration as this is necessary input information.
nitrificationInhibitorUsed	boolean or null This is needed for carbon farming to be able to compute carbon sequestration as this is necessary input information.
overrideVraRestriction	boolean or null Default: false If true, it will disable the fallback to FLAT in case of some limitations for the crop season. Note that `limitationReasons` would still be populated in the response if the fallback to FLAT happens but is overriden. Only valid for VRA dosed maps. Ignored otherwise.
	Array of objects
referenceZoneId	string Optional. Reference zone id: zone id (`class_id` property of the feature collection) of the zone which gets rate factor = `1.0`. If not provided, `referenceZoneId` takes value `1` by default. Zones with `zoneId < referenceZoneId` will get increase of the rate factors according to provided `baseFactor` value. Zones with `zoneId > referenceZoneId` will get reduction of the rate factors according to provided `baseFactor` value.

Responses

Request samples

Payload

Content type

application/json

Example

FLAT

{"cropSeasonUuid": "4eb7eb0f-c0a7-4df7-8c51-1e38556ab704",
"productPackUuids": ["351a457a-c400-446a-85d1-9652f21f56ee"
],
"recommendationDate": "2021-01-17T23:00:00.000Z",
"isHighFlow": false,
"applicationType": "FLAT",
"waterRates": [0.00002
],
"rates": [{"uuid": "04341501-c153-b2f1-b58e-999cc8776333",
"type": "PRODUCT",
"rates": [2e-7
],
"localUnitUuid": "4eb7eb0f-c0a7-4df7-8c51-1e38556ab704",
"volumeBasisLocalUnitUuid": "4eb7eb0f-c0a7-4df7-8c51-1e38556ab704",
"volumeBasisRate": 1.2,
"dilutionFactor": 12.5
}
],
"creationFlowHint": "CROP_PROTECTION",
"applicationDepth": 6.7,
"ureaseInhibitorUsed": true,
"nitrificationInhibitorUsed": true
}

Response samples

201
400

Content type

application/json

Example

FLAT

{"uuid": "d58fb01e-06f2-40dc-b861-faa60fc19c80",
"cropSeasonUuid": "4eb7eb0f-c0a7-4df7-8c51-1e38556ab704",
"productPackUuids": ["351a457a-c400-446a-85d1-9652f21f56ee"
],
"sourceMapUuid": "a28bc4e5-9b63-4cef-a957-d9fedf430eff",
"applicationType": "FLAT",
"applicationMode": "SPRAYING",
"actionTypes": ["FUNGICIDE_APPLICATION",
"PLANT_GROWTH_REGULATOR_APPLICATION"
],
"waterRates": [0.00002
],
"rates": [{"uuid": "04341501-c153-b2f1-b58e-999cc8776333",
"rates": [2e-7
],
"type": "PRODUCT",
"unit": "M3PM2",
"localUnitUuid": "4eb7eb0f-c0a7-4df7-8c51-1e38556ab704",
"volumeBasisLocalUnitUuid": "4eb7eb0f-c0a7-4df7-8c51-1e38556ab704",
"volumeBasisRate": 1.2,
"dilutionFactor": 12.5
}
],
"rxValues": [0.00002
],
"waterAverageApplicationRate": 0.0000198,
"waterTotalApplication": 1.2212892,
"applicationZones": [{"id": "1",
"category": "FLAT",
"area": 61681.273,
"rate": 0.00002,
"active": true
}
],
"fieldZones": null,
"dateCreated": "2021-01-18T15:55:01.56Z",
"imageUrl": "https://gis.digital-farming.com/dosed-map/wms?layers=dosed-map%3Adosed_map&viewparams=dosed_map_uuid%3Ad58fb01e-06f2-40dc-b861-faa60fc19c80&service=WMS&version=1.1.0&request=GetMap&styles=DOSED_MAP_FLAT&bbox=821363.6381832166%2C6600891.554041418%2C821829.4323285429%2C6601248.660493603&width=1024&height=785&srs=EPSG%3A3857&format=image%2Fpng8&transparent=true",
"checksum": "2012e284412014f56bbb75535b6532285e8600bd17db654b00af21cd575ef0ec",
"subscriptionStatus": "SUBSCRIBED",
"geoserverUrl": "https://gis.digital-farming.com/dosed-map/wms?layers=dosed-map%3Adosed_map&viewparams=dosed_map_uuid%3Ad58fb01e-06f2-40dc-b861-faa60fc19c80",
"recipeV2": [{"uuid": "04341501-c153-b2f1-b58e-999cc8776333",
"type": "PRODUCT",
"formulation": "LIQUID",
"averageApplicationRate": 2e-7,
"totalApplication": 0.012336255,
"unit": "M3PM2",
"localUnitUuid": "4eb7eb0f-c0a7-4df7-8c51-1e38556ab704",
"volumeBasisLocalUnitUuid": "4eb7eb0f-c0a7-4df7-8c51-1e38556ab704",
"volumeBasisRate": 1.2,
"dilutionFactor": 12.5,
"ratesPerZone": [2e-7
],
"ratesByZone": [{"id": "1",
"rate": 2e-7
}
]
},
{"uuid": "ed5c78aa-70c1-4d2a-b80c-47f4df3d3671",
"type": "WATER",
"formulation": "LIQUID",
"averageApplicationRate": 0.0000198,
"totalApplication": 1.2212892,
"unit": "M3PM2",
"localUnitUuid": "4eb7eb0f-c0a7-4df7-8c51-1e38556ab704",
"volumeBasisLocalUnitUuid": "4eb7eb0f-c0a7-4df7-8c51-1e38556ab704",
"volumeBasisRate": 1.2,
"dilutionFactor": 12.5,
"ratesPerZone": [0.0000198
],
"ratesByZone": [{"id": "1",
"rate": 0.0000198
}
]
}
],
"totalArea": 61681.27236282214,
"applicationSpotUuid": "8b629743-ac91-4610-a17d-4a0688b547e9",
"isHighFlow": false,
"taskMethodUuid": "0a404a03-a37e-4302-b8a7-33e74e4e0670",
"creationFlowHint": "CROP_PROTECTION",
"applicationDepth": 6.7,
"ureaseInhibitorUsed": true,
"nitrificationInhibitorUsed": true
}

Get single dosed map

Authorizations:

OAuth2

path Parameters

uuid

required

string <uuid>

Example: 199067a9-5bb1-4f20-9641-a35d5ce31e19

Define resource by uuid

query Parameters

includeComponentRates	boolean Default: false Provide not only the product application rates, but also the rates of all individual components of the tank mix in the response. The correct amounts are fetched on-the-fly from master-data, so please only include if you actually need them.
$extends	Array of strings Items Value: "geometry" Example: $extends=geometry Extends enriches the response with `geometry` geojson property. If not sent `geometry` will be `null` in the response.

header Parameters

If-None-Match

string

Example: "1"

ETag of the resource to fetch. If the resource is unchanged on the server it will respond with 304 Not Modified

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag

Responses

Response samples

200
400

Content type

application/json

Example

FLAT

{"uuid": "d58fb01e-06f2-40dc-b861-faa60fc19c80",
"cropSeasonUuid": "4eb7eb0f-c0a7-4df7-8c51-1e38556ab704",
"productPackUuids": ["351a457a-c400-446a-85d1-9652f21f56ee"
],
"sourceMapUuid": "a28bc4e5-9b63-4cef-a957-d9fedf430eff",
"applicationType": "FLAT",
"applicationMode": "SPRAYING",
"actionTypes": ["FUNGICIDE_APPLICATION",
"PLANT_GROWTH_REGULATOR_APPLICATION"
],
"waterRates": [0.00002
],
"rates": [{"uuid": "04341501-c153-b2f1-b58e-999cc8776333",
"rates": [2e-7
],
"type": "PRODUCT",
"unit": "M3PM2",
"localUnitUuid": "4eb7eb0f-c0a7-4df7-8c51-1e38556ab704",
"volumeBasisLocalUnitUuid": "4eb7eb0f-c0a7-4df7-8c51-1e38556ab704",
"volumeBasisRate": 1.2,
"dilutionFactor": 12.5
}
],
"rxValues": [0.00002
],
"waterAverageApplicationRate": 0.0000198,
"waterTotalApplication": 1.2212892,
"applicationZones": [{"id": "1",
"category": "FLAT",
"area": 61681.273,
"rate": 0.00002,
"active": true
}
],
"fieldZones": null,
"dateCreated": "2021-01-18T15:55:01.56Z",
"imageUrl": "https://gis.digital-farming.com/dosed-map/wms?layers=dosed-map%3Adosed_map&viewparams=dosed_map_uuid%3Ad58fb01e-06f2-40dc-b861-faa60fc19c80&service=WMS&version=1.1.0&request=GetMap&styles=DOSED_MAP_FLAT&bbox=821363.6381832166%2C6600891.554041418%2C821829.4323285429%2C6601248.660493603&width=1024&height=785&srs=EPSG%3A3857&format=image%2Fpng8&transparent=true",
"checksum": "2012e284412014f56bbb75535b6532285e8600bd17db654b00af21cd575ef0ec",
"subscriptionStatus": "SUBSCRIBED",
"geoserverUrl": "https://gis.digital-farming.com/dosed-map/wms?layers=dosed-map%3Adosed_map&viewparams=dosed_map_uuid%3Ad58fb01e-06f2-40dc-b861-faa60fc19c80",
"recipeV2": [{"uuid": "04341501-c153-b2f1-b58e-999cc8776333",
"type": "PRODUCT",
"formulation": "LIQUID",
"averageApplicationRate": 2e-7,
"totalApplication": 0.012336255,
"unit": "M3PM2",
"localUnitUuid": "4eb7eb0f-c0a7-4df7-8c51-1e38556ab704",
"volumeBasisLocalUnitUuid": "4eb7eb0f-c0a7-4df7-8c51-1e38556ab704",
"volumeBasisRate": 1.2,
"dilutionFactor": 12.5,
"ratesPerZone": [2e-7
],
"ratesByZone": [{"id": "1",
"rate": 2e-7
}
]
},
{"uuid": "ed5c78aa-70c1-4d2a-b80c-47f4df3d3671",
"type": "WATER",
"formulation": "LIQUID",
"averageApplicationRate": 0.0000198,
"totalApplication": 1.2212892,
"unit": "M3PM2",
"localUnitUuid": "4eb7eb0f-c0a7-4df7-8c51-1e38556ab704",
"volumeBasisLocalUnitUuid": "4eb7eb0f-c0a7-4df7-8c51-1e38556ab704",
"volumeBasisRate": 1.2,
"dilutionFactor": 12.5,
"ratesPerZone": [0.0000198
],
"ratesByZone": [{"id": "1",
"rate": 0.0000198
}
]
}
],
"totalArea": 61681.27236282214,
"applicationSpotUuid": "8b629743-ac91-4610-a17d-4a0688b547e9",
"isHighFlow": false,
"taskMethodUuid": "0a404a03-a37e-4302-b8a7-33e74e4e0670",
"creationFlowHint": "CROP_PROTECTION",
"applicationDepth": 6.7,
"ureaseInhibitorUsed": true,
"nitrificationInhibitorUsed": true
}

Sprayings

A spraying associates date information with product/water dosage information to a crop season. The dates describe when the task is planned to be executed and when it actually has been executed. The product/water dosage information is represented by a dosed map reference.

Get Sprayings

Retrieve spraying tasks filtered by UUID, crop season UUID, and optional date range. When filtering by date range, both fromDate and tillDate must be provided together to filter spraying tasks created within the specified time range (inclusive). The fromDate cannot be after tillDate.

Authorizations:

OAuth2

query Parameters

uuid	Array of strings <uuid> Example: uuid=199067a9-5bb1-4f20-9641-a35d5ce31e19 Filter by resource uuid
cropSeasonUuid	Array of strings <uuid> Example: cropSeasonUuid=2a84e031-c5c6-4fcf-95f6-1341c5ebef80 Filter by cropseason uuid
fromDate	string <date-time> Example: fromDate=2019-04-03T16:42:23Z from date
tillDate	string <date-time> Example: tillDate=2019-04-03T16:42:23Z till date
$extends	Array of strings Items Value: "boundary" Example: $extends=boundary Enriches the response with the task's `boundary` as geojson. If not sent, the `boundary` will be `null` in the response.

Responses

Response samples

200

Content type

application/json

[{"uuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"creatorId": "e7dac807da134b05b58933df9df5ef44",
"lastModifierId": "e7dac807da134b05b58933df9df5ef44",
"etag": "\"1\"",
"cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"plannedDate": "2019-04-03T16:42:23Z",
"executionDate": "2019-04-03T16:42:23Z",
"autoExecutedOn": "2019-04-03T16:42:23Z",
"isAutoExecutable": true,
"assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"note": "A dummy note",
"assignmentState": "ACCEPTED",
"state": "PLANNED",
"dateCreated": "2019-04-01T16:42:23Z",
"dosedMapUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"availableDosedMaps": [{"uuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"equipmentType": "DRONE"
}
],
"asAppliedDosedMapUuid": "78af659c-fd01-4647-8a06-e075e9988296",
"recommendationUuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"weedRecordUuid": "47983bd3-b41f-473a-9ec8-be94aefac1f5",
"fieldInputPackagingUuid": "5ed4f0bc-1be2-4e45-b722-db0dae7872e2",
"fieldInputPackagingUuids": ["2eeeb6fd-7a10-4f0c-a52d-e9d08e794cb8",
"2eeeb6fd-7a10-4f0c-a52d-e9d08e794cb9"
],
"boundary": "{\"type\":\"FeatureCollection\",\"features\":[{\"type\":\"Feature\",\"geometry\":{\"type\":\"MultiPolygon\",\"coordinates\":[[[[8.2343514082,52.2875129922],[8.2352742683,52.2881572627],[8.2358215457,52.2873420617],[8.2347806454,52.286710928],[8.2343514082,52.2875129922]]]]}}]}",
"executionStartDate": "2019-04-03T16:42:23Z"
}
]

Create spraying

Sprayings can be planned ahead of time. In that case only provide the plannedDate. If the spraying was already executed: set executionDate and plannedDate to the same value. It is not possible to set the executionDate to a future date. Both dates can be edited later.

Either a single dosedMapUuid or a list of availableDosedMaps with equipmentTypes have to be provided, but not both.

Authorizations:

OAuth2

Request Body schema: application/json

cropSeasonUuid required	string <uuid>
isAutoExecutable required	boolean or null
plannedDate required	string <date-time>
executionDate	string or null <date-time>
assigneeUuid	string or null <uuid> collaborator UUID, collaborators
note	string or null <= 5196 characters
assignmentState	string Enum: "ACCEPTED" "REJECTED" "UNACKNOWLEDGED" "UNASSIGNED"
dosedMapUuid	string <uuid> dosedMapUuid of availableDosedMaps with equipment type STANDARD for not executable tasks, or the dosedmapUuid of the executable dosedMapUuid.
	Array of objects Set all available dosed maps for different equipment types. availableDosedMaps should be null or not empty list. If not null, it should contain at least one object with dosedMapUuid with equipmentType STANDARD or max 2 objects with different equipment types.
asAppliedDosedMapUuid	string <uuid>
recommendationUuid	string <uuid>
weedRecordUuid	string <uuid>
fieldInputPackagingUuid	string <uuid> Deprecated Deprecated. Use `fieldInputPackagingUuids` instead.
fieldInputPackagingUuids	Array of strings <uuid> List of field input packaging uuids.
executionStartDate	string or null <date-time> Start date of the task execution. This should be set for cases when task execution lasts for more than 1 day. Then the `executionDate` attribute will have meaning of the actual execution end date.

Responses

Request samples

Payload

Content type

application/json

{"cropSeasonUuid": "ec8a3e6e-30ec-41b3-a007-adf2d87dc296",
"isAutoExecutable": true,
"plannedDate": "2019-04-03T16:42:23Z",
"executionDate": "2019-04-03T16:42:23Z",
"assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"note": "A dummy note",
"assignmentState": "ACCEPTED",
"dosedMapUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"availableDosedMaps": [{"uuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"equipmentType": "DRONE"
}
],
"asAppliedDosedMapUuid": "78af659c-fd01-4647-8a06-e075e9988296",
"recommendationUuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"weedRecordUuid": "47983bd3-b41f-473a-9ec8-be94aefac1f5",
"fieldInputPackagingUuid": "5ed4f0bc-1be2-4e45-b722-db0dae7872e2",
"fieldInputPackagingUuids": ["2eeeb6fd-7a10-4f0c-a52d-e9d08e794cb8",
"2eeeb6fd-7a10-4f0c-a52d-e9d08e794cb9"
],
"executionStartDate": "2019-04-03T16:42:23Z"
}

Response samples

201
400

Content type

application/json

{"uuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"creatorId": "e7dac807da134b05b58933df9df5ef44",
"lastModifierId": "e7dac807da134b05b58933df9df5ef44",
"etag": "\"1\"",
"cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"plannedDate": "2019-04-03T16:42:23Z",
"executionDate": "2019-04-03T16:42:23Z",
"autoExecutedOn": "2019-04-03T16:42:23Z",
"isAutoExecutable": true,
"assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"note": "A dummy note",
"assignmentState": "ACCEPTED",
"state": "PLANNED",
"dateCreated": "2019-04-01T16:42:23Z",
"dosedMapUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"availableDosedMaps": [{"uuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"equipmentType": "DRONE"
}
],
"asAppliedDosedMapUuid": "78af659c-fd01-4647-8a06-e075e9988296",
"recommendationUuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"weedRecordUuid": "47983bd3-b41f-473a-9ec8-be94aefac1f5",
"fieldInputPackagingUuid": "5ed4f0bc-1be2-4e45-b722-db0dae7872e2",
"fieldInputPackagingUuids": ["2eeeb6fd-7a10-4f0c-a52d-e9d08e794cb8",
"2eeeb6fd-7a10-4f0c-a52d-e9d08e794cb9"
],
"boundary": "{\"type\":\"FeatureCollection\",\"features\":[{\"type\":\"Feature\",\"geometry\":{\"type\":\"MultiPolygon\",\"coordinates\":[[[[8.2343514082,52.2875129922],[8.2352742683,52.2881572627],[8.2358215457,52.2873420617],[8.2347806454,52.286710928],[8.2343514082,52.2875129922]]]]}}]}",
"executionStartDate": "2019-04-03T16:42:23Z"
}

Get single spraying

Authorizations:

OAuth2

path Parameters

uuid

required

string <uuid>

Example: 199067a9-5bb1-4f20-9641-a35d5ce31e19

Define resource by uuid

query Parameters

$extends

Array of strings

Items Value: "boundary"

Example: $extends=boundary

Enriches the response with the task's boundary as geojson.

If not sent, the boundary will be null in the response.

header Parameters

If-None-Match

string

Example: "1"

ETag of the resource to fetch. If the resource is unchanged on the server it will respond with 304 Not Modified

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag

Responses

Response samples

200
400

Content type

application/json

{"uuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"creatorId": "e7dac807da134b05b58933df9df5ef44",
"lastModifierId": "e7dac807da134b05b58933df9df5ef44",
"etag": "\"1\"",
"cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"plannedDate": "2019-04-03T16:42:23Z",
"executionDate": "2019-04-03T16:42:23Z",
"autoExecutedOn": "2019-04-03T16:42:23Z",
"isAutoExecutable": true,
"assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"note": "A dummy note",
"assignmentState": "ACCEPTED",
"state": "PLANNED",
"dateCreated": "2019-04-01T16:42:23Z",
"dosedMapUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"availableDosedMaps": [{"uuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"equipmentType": "DRONE"
}
],
"asAppliedDosedMapUuid": "78af659c-fd01-4647-8a06-e075e9988296",
"recommendationUuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"weedRecordUuid": "47983bd3-b41f-473a-9ec8-be94aefac1f5",
"fieldInputPackagingUuid": "5ed4f0bc-1be2-4e45-b722-db0dae7872e2",
"fieldInputPackagingUuids": ["2eeeb6fd-7a10-4f0c-a52d-e9d08e794cb8",
"2eeeb6fd-7a10-4f0c-a52d-e9d08e794cb9"
],
"boundary": "{\"type\":\"FeatureCollection\",\"features\":[{\"type\":\"Feature\",\"geometry\":{\"type\":\"MultiPolygon\",\"coordinates\":[[[[8.2343514082,52.2875129922],[8.2352742683,52.2881572627],[8.2358215457,52.2873420617],[8.2347806454,52.286710928],[8.2343514082,52.2875129922]]]]}}]}",
"executionStartDate": "2019-04-03T16:42:23Z"
}

Update spraying

Note that it is not possible to specify both dosedMapUuid and availableDosedMaps at the same time.

Authorizations:

OAuth2

path Parameters

uuid

required

string <uuid>

Example: 199067a9-5bb1-4f20-9641-a35d5ce31e19

Define resource by uuid

header Parameters

If-Match

required

string

Example: "1"

ETag of the resource to update.

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag

Request Body schema: application/merge-patch+json

plannedDate	string <date-time>
executionDate	string or null <date-time>
isAutoExecutable	boolean or null
assigneeUuid	string or null <uuid> collaborator UUID, collaborators
note	string or null <= 5196 characters
assignmentState	string Enum: "ACCEPTED" "REJECTED" "UNACKNOWLEDGED" "UNASSIGNED"
dosedMapUuid	string <uuid> dosedMapUuid of availableDosedMaps with equipment type STANDARD for not executable tasks, or the dosedmapUuid of the executable dosedMapUuid.
	Array of objects Set all available dosed maps for different equipment types. availableDosedMaps should be null or not empty list. If not null, it should contain at least one object with dosedMapUuid with equipmentType STANDARD or max 2 objects with different equipment types.
asAppliedDosedMapUuid	string <uuid>
recommendationUuid	string <uuid>
weedRecordUuid	string <uuid>
fieldInputPackagingUuid	string <uuid> Deprecated Deprecated. Use `fieldInputPackagingUuids` instead.
fieldInputPackagingUuids	Array of strings <uuid> List of field input packaging uuids.
executionStartDate	string or null <date-time> Start date of the task execution. This should be set for cases when task execution lasts for more than 1 day. Then the `executionDate` attribute will have meaning of the actual execution end date.

Responses

Request samples

Payload

Content type

application/merge-patch+json

{"plannedDate": "2019-04-03T16:42:23Z",
"executionDate": "2019-04-03T16:42:23Z",
"isAutoExecutable": true,
"assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"note": "A dummy note",
"assignmentState": "ACCEPTED",
"dosedMapUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"availableDosedMaps": [{"uuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"equipmentType": "DRONE"
}
],
"asAppliedDosedMapUuid": "78af659c-fd01-4647-8a06-e075e9988296",
"recommendationUuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"weedRecordUuid": "47983bd3-b41f-473a-9ec8-be94aefac1f5",
"fieldInputPackagingUuid": "5ed4f0bc-1be2-4e45-b722-db0dae7872e2",
"fieldInputPackagingUuids": ["2eeeb6fd-7a10-4f0c-a52d-e9d08e794cb8",
"2eeeb6fd-7a10-4f0c-a52d-e9d08e794cb9"
],
"executionStartDate": "2019-04-03T16:42:23Z"
}

Response samples

200
400
412
428

Content type

application/json

{"uuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"creatorId": "e7dac807da134b05b58933df9df5ef44",
"lastModifierId": "e7dac807da134b05b58933df9df5ef44",
"etag": "\"1\"",
"cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"plannedDate": "2019-04-03T16:42:23Z",
"executionDate": "2019-04-03T16:42:23Z",
"autoExecutedOn": "2019-04-03T16:42:23Z",
"isAutoExecutable": true,
"assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"note": "A dummy note",
"assignmentState": "ACCEPTED",
"state": "PLANNED",
"dateCreated": "2019-04-01T16:42:23Z",
"dosedMapUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"availableDosedMaps": [{"uuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"equipmentType": "DRONE"
}
],
"asAppliedDosedMapUuid": "78af659c-fd01-4647-8a06-e075e9988296",
"recommendationUuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"weedRecordUuid": "47983bd3-b41f-473a-9ec8-be94aefac1f5",
"fieldInputPackagingUuid": "5ed4f0bc-1be2-4e45-b722-db0dae7872e2",
"fieldInputPackagingUuids": ["2eeeb6fd-7a10-4f0c-a52d-e9d08e794cb8",
"2eeeb6fd-7a10-4f0c-a52d-e9d08e794cb9"
],
"boundary": "{\"type\":\"FeatureCollection\",\"features\":[{\"type\":\"Feature\",\"geometry\":{\"type\":\"MultiPolygon\",\"coordinates\":[[[[8.2343514082,52.2875129922],[8.2352742683,52.2881572627],[8.2358215457,52.2873420617],[8.2347806454,52.286710928],[8.2343514082,52.2875129922]]]]}}]}",
"executionStartDate": "2019-04-03T16:42:23Z"
}

Delete spraying

Authorizations:

OAuth2

path Parameters

uuid

required

string <uuid>

Example: 199067a9-5bb1-4f20-9641-a35d5ce31e19

Define resource by uuid

Responses

Observations

An observation can contain information about an observed growth stage or certain diseases

Create observation

Observations associates diseases information of the crop

At least one of importantStageUuid | stressAnswerUuids fields is mandatory.

Authorizations:

OAuth2

Request Body schema: application/json

cropSeasonUuid required	string <uuid>
executionDate required	string <date-time>
importantStageUuid required	string <uuid>
stressAnswerUuids	Array of strings <uuid>

Responses

Request samples

Payload

Content type

application/json

{"cropSeasonUuid": "ec8a3e6e-30ec-41b3-a007-adf2d87dc296",
"executionDate": "2019-04-03T16:42:23Z",
"importantStageUuid": "6c8a42be-1bc5-47a0-b671-251045e04a61",
"stressAnswerUuids": ["199067a9-5bb1-4f20-9641-a35d5ce31e19"
]
}

Response samples

201
400

Content type

application/json

[{"uuid": "78af659c-fd01-4647-8a06-e075e9988296",
"cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"executionDate": "2019-04-03T16:42:23Z",
"importantStageUuid": "6c8a42be-1bc5-47a0-b671-251045e04a61",
"stressAnswerUuids": ["199067a9-5bb1-4f20-9641-a35d5ce31e19"
],
"overriddenImportantGrowthStageUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80"
}
]

Get observation

Authorizations:

OAuth2

query Parameters

uuid	Array of strings <uuid> Example: uuid=199067a9-5bb1-4f20-9641-a35d5ce31e19 Filter by resource uuid
cropSeasonUuid	Array of strings <uuid> Example: cropSeasonUuid=2a84e031-c5c6-4fcf-95f6-1341c5ebef80 Filter by cropseason uuid

Responses

Response samples

200
400
404

Content type

application/json

[{"uuid": "78af659c-fd01-4647-8a06-e075e9988296",
"cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"executionDate": "2019-04-03T16:42:23Z",
"importantStageUuid": "6c8a42be-1bc5-47a0-b671-251045e04a61",
"stressAnswerUuids": ["199067a9-5bb1-4f20-9641-a35d5ce31e19"
],
"overriddenImportantGrowthStageUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80"
}
]

Delete observation

Authorizations:

OAuth2

path Parameters

uuid

required

string <uuid>

Example: 199067a9-5bb1-4f20-9641-a35d5ce31e19

Define resource by uuid

Responses

Water Management Task

Manage water tasks in field manager.

Get water management tasks

Authorizations:

OAuth2

query Parameters

uuid	Array of strings <uuid> Example: uuid=199067a9-5bb1-4f20-9641-a35d5ce31e19 Filter by resource uuid
cropSeasonUuid	Array of strings <uuid> Example: cropSeasonUuid=2a84e031-c5c6-4fcf-95f6-1341c5ebef80 Filter by cropseason uuid

Responses

Response samples

200
400

Content type

application/json

[{"uuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"creatorId": "e7dac807da134b05b58933df9df5ef44",
"lastModifierId": "e7dac807da134b05b58933df9df5ef44",
"etag": "\"1\"",
"cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"plannedDate": "2019-04-03T16:42:23Z",
"executionDate": null,
"autoExecutedOn": "2019-04-03T16:42:23Z",
"isAutoExecutable": true,
"assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"note": "A dummy note",
"assignmentState": "ACCEPTED",
"state": "PLANNED",
"dateCreated": "2019-04-01T16:42:23Z",
"type": "IRRIGATION",
"waterHeightDifference": 0.2,
"waterHeight": 1.2,
"executionStartDate": "2022-04-03T16:42:23Z",
"fieldCoveragePercentage": 45.1,
"taskMethodUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"irrigationTypeUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"irrigationWaterSourceUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"processedArea": 121.3,
"irrigationSystemUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80"
}
]

Create a water management task

Authorizations:

OAuth2

Request Body schema: application/json

cropSeasonUuid required	string <uuid>
type required	string Enum: "IRRIGATION" "DRAINAGE"
plannedDate	string <date-time>
executionDate	string or null <date-time> The end time of irrigation tasks.
isAutoExecutable	boolean or null
assigneeUuid	string or null <uuid> collaborator UUID, collaborators
note	string or null <= 5196 characters
assignmentState	string Enum: "ACCEPTED" "REJECTED" "UNACKNOWLEDGED" "UNASSIGNED"
waterHeightDifference	number or null <double> Positive number, measured in m. Standing water height addition or removal. For Rice, atleast waterHeightDifference or waterHeight is required. waterHeightDifference is required for any other crop.
waterHeight	number or null <double> Positive number, measured in m. Standing water height in the field. For Rice, atleast waterHeightDifference or waterHeight is required.
executionStartDate	string or null <date-time> The start time of irrigation tasks.
fieldCoveragePercentage	number or null <double> [ 0 .. 100 ] Default: 100 Percentage of task coverage on a field.
taskMethodUuid	string or null <uuid> Task method uuid , masterdata-dictionary with dict=TASKMETHOD
irrigationTypeUuid	string or null <uuid> Irrigation type uuid , masterdata-dictionary with dict=IRRIGATIONTYPE
irrigationWaterSourceUuid	string or null <uuid> Irrigation water source uuid , masterdata-dictionary with dict=IRRIGATIONWATERSOURCE
processedArea	number or null <double> >= 0 Area that was processed in the water management task
irrigationSystemUuid	string or null <uuid> Irrigation system uuid , masterdata-dictionary with dict=IRRIGATIONSYSTEM

Responses

Request samples

Payload

Content type

application/json

{"cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"type": "IRRIGATION",
"plannedDate": "2019-04-03T16:42:23Z",
"executionDate": null,
"isAutoExecutable": true,
"assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"note": "A dummy note",
"assignmentState": "ACCEPTED",
"waterHeightDifference": 0.2,
"waterHeight": 1.2,
"executionStartDate": "2022-04-03T16:42:23Z",
"fieldCoveragePercentage": 45.1,
"taskMethodUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"irrigationTypeUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"irrigationWaterSourceUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"processedArea": 121.3,
"irrigationSystemUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80"
}

Response samples

201
400

Content type

application/json

{"uuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"creatorId": "e7dac807da134b05b58933df9df5ef44",
"lastModifierId": "e7dac807da134b05b58933df9df5ef44",
"etag": "\"1\"",
"cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"plannedDate": "2019-04-03T16:42:23Z",
"executionDate": null,
"autoExecutedOn": "2019-04-03T16:42:23Z",
"isAutoExecutable": true,
"assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"note": "A dummy note",
"assignmentState": "ACCEPTED",
"state": "PLANNED",
"dateCreated": "2019-04-01T16:42:23Z",
"type": "IRRIGATION",
"waterHeightDifference": 0.2,
"waterHeight": 1.2,
"executionStartDate": "2022-04-03T16:42:23Z",
"fieldCoveragePercentage": 45.1,
"taskMethodUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"irrigationTypeUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"irrigationWaterSourceUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"processedArea": 121.3,
"irrigationSystemUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80"
}

Get single water management task

Authorizations:

OAuth2

path Parameters

uuid

required

string <uuid>

Example: 199067a9-5bb1-4f20-9641-a35d5ce31e19

Define resource by uuid

Responses

Response samples

200

Content type

application/json

{"uuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"creatorId": "e7dac807da134b05b58933df9df5ef44",
"lastModifierId": "e7dac807da134b05b58933df9df5ef44",
"etag": "\"1\"",
"cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"plannedDate": "2019-04-03T16:42:23Z",
"executionDate": null,
"autoExecutedOn": "2019-04-03T16:42:23Z",
"isAutoExecutable": true,
"assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"note": "A dummy note",
"assignmentState": "ACCEPTED",
"state": "PLANNED",
"dateCreated": "2019-04-01T16:42:23Z",
"type": "IRRIGATION",
"waterHeightDifference": 0.2,
"waterHeight": 1.2,
"executionStartDate": "2022-04-03T16:42:23Z",
"fieldCoveragePercentage": 45.1,
"taskMethodUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"irrigationTypeUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"irrigationWaterSourceUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"processedArea": 121.3,
"irrigationSystemUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80"
}

Update water management task

Authorizations:

OAuth2

path Parameters

uuid

required

string <uuid>

Example: 199067a9-5bb1-4f20-9641-a35d5ce31e19

Define resource by uuid

header Parameters

If-Match

required

string

Example: "1"

ETag of the resource to update.

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag

Request Body schema: application/merge-patch+json

plannedDate	string <date-time>
executionDate	string or null <date-time> The end time of irrigation tasks.
isAutoExecutable	boolean or null
assigneeUuid	string or null <uuid> collaborator UUID, collaborators
note	string or null <= 5196 characters
assignmentState	string Enum: "ACCEPTED" "REJECTED" "UNACKNOWLEDGED" "UNASSIGNED"
waterHeightDifference	number or null <double> Positive number, measured in m. Standing water height addition or removal. For Rice, atleast waterHeightDifference or waterHeight is required. waterHeightDifference is required for any other crop.
waterHeight	number or null <double> Positive number, measured in m. Standing water height in the field. For Rice, atleast waterHeightDifference or waterHeight is required.
executionStartDate	string or null <date-time> The start time of irrigation tasks.
fieldCoveragePercentage	number or null <double> [ 0 .. 100 ] Default: 100 Percentage of task coverage on a field.
taskMethodUuid	string or null <uuid> Task method uuid , masterdata-dictionary with dict=TASKMETHOD
irrigationTypeUuid	string or null <uuid> Irrigation type uuid , masterdata-dictionary with dict=IRRIGATIONTYPE
irrigationWaterSourceUuid	string or null <uuid> Irrigation water source uuid , masterdata-dictionary with dict=IRRIGATIONWATERSOURCE
processedArea	number or null <double> >= 0 Area that was processed in the water management task
irrigationSystemUuid	string or null <uuid> Irrigation system uuid , masterdata-dictionary with dict=IRRIGATIONSYSTEM

Responses

Request samples

Payload

Content type

application/merge-patch+json

{"plannedDate": "2019-04-03T16:42:23Z",
"executionDate": null,
"isAutoExecutable": true,
"assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"note": "A dummy note",
"assignmentState": "ACCEPTED",
"waterHeightDifference": 0.2,
"waterHeight": 1.2,
"executionStartDate": "2022-04-03T16:42:23Z",
"fieldCoveragePercentage": 45.1,
"taskMethodUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"irrigationTypeUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"irrigationWaterSourceUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"processedArea": 121.3,
"irrigationSystemUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80"
}

Response samples

200
400
412
428

Content type

application/json

{"uuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"creatorId": "e7dac807da134b05b58933df9df5ef44",
"lastModifierId": "e7dac807da134b05b58933df9df5ef44",
"etag": "\"1\"",
"cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"plannedDate": "2019-04-03T16:42:23Z",
"executionDate": null,
"autoExecutedOn": "2019-04-03T16:42:23Z",
"isAutoExecutable": true,
"assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"note": "A dummy note",
"assignmentState": "ACCEPTED",
"state": "PLANNED",
"dateCreated": "2019-04-01T16:42:23Z",
"type": "IRRIGATION",
"waterHeightDifference": 0.2,
"waterHeight": 1.2,
"executionStartDate": "2022-04-03T16:42:23Z",
"fieldCoveragePercentage": 45.1,
"taskMethodUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"irrigationTypeUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"irrigationWaterSourceUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"processedArea": 121.3,
"irrigationSystemUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80"
}

Delete a water management task

Authorizations:

OAuth2

path Parameters

uuid

required

string <uuid>

Example: 199067a9-5bb1-4f20-9641-a35d5ce31e19

Define resource by uuid

Responses

Seed Treatment Task

Seed Treatment Task for the seed of the crop to be treated before sowing.

Create a seed treatment task

Authorizations:

OAuth2

Request Body schema: application/json

cropSeasonUuid required	string <uuid>
autoExecutedOn	string or null <date-time>
plannedDate required	string <date-time>
executionDate	string or null <date-time>
isAutoExecutable	boolean or null
assigneeUuid	string or null <uuid> collaborator UUID, collaborators
note	string or null <= 5196 characters
assignmentState	string Enum: "ACCEPTED" "REJECTED" "UNACKNOWLEDGED" "UNASSIGNED"
totalLiquidRate	number <double> total liquid rate in m3/kg for LIQUID
required	Array of objects <= 20 items Array of product limited to max of 20 products
taskMethodUuid required	string Enum: "POWDERING" "LONG_DIP" "SHORT_DIP" "SPRAYING" "COATING" Task method for seed treatment. masterdata-dictionary with dict=TASKMETHOD

Responses

Request samples

Payload

Content type

application/json

{"cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"autoExecutedOn": "2019-04-03T16:42:23Z",
"plannedDate": "2019-04-03T16:42:23Z",
"executionDate": "2019-04-03T16:42:23Z",
"isAutoExecutable": true,
"assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"note": "A dummy note",
"assignmentState": "ACCEPTED",
"totalLiquidRate": 0.03,
"products": [{"uuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"applicationRate": 0.03,
"dilutionFactor": 1.3
}
],
"taskMethodUuid": "POWDERING"
}

Response samples

201
400

Content type

application/json

{"uuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"creatorId": "e7dac807da134b05b58933df9df5ef44",
"lastModifierId": "e7dac807da134b05b58933df9df5ef44",
"etag": "\"1\"",
"cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"plannedDate": "2019-04-03T16:42:23Z",
"executionDate": "2019-04-03T16:42:23Z",
"autoExecutedOn": "2019-04-03T16:42:23Z",
"isAutoExecutable": true,
"assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"note": "A dummy note",
"assignmentState": "ACCEPTED",
"state": "PLANNED",
"dateCreated": "2019-04-01T16:42:23Z",
"totalLiquidRate": 0.03,
"products": [{"uuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"applicationRate": 0.03,
"unit": "M3_KG",
"dilutionFactor": 1.3
}
],
"taskMethodUuid": "POWDERING",
"recipe": [{"uuid": "b7784b3b-1f9b-bc42-f65d-1cf9f02eaede",
"type": "PRODUCT",
"averageApplicationRate": 0.000015926667,
"totalApplication": 0.00039,
"productFormulationTypeGroup": "199067a9-5bb1-4f20-9641-a35d5ce31e19",
"name": "Test Product",
"productFormulationTypeGroupName": "LIQUID",
"organization": "Test org1, Test Org2"
}
]
}

Get seed treatment tasks

Authorizations:

OAuth2

query Parameters

uuid	Array of strings <uuid> Example: uuid=199067a9-5bb1-4f20-9641-a35d5ce31e19 Filter by resource uuid
cropSeasonUuid	Array of strings <uuid> Example: cropSeasonUuid=2a84e031-c5c6-4fcf-95f6-1341c5ebef80 Filter by cropseason uuid

Responses

Response samples

200
400

Content type

application/json

[{"uuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"creatorId": "e7dac807da134b05b58933df9df5ef44",
"lastModifierId": "e7dac807da134b05b58933df9df5ef44",
"etag": "\"1\"",
"cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"plannedDate": "2019-04-03T16:42:23Z",
"executionDate": "2019-04-03T16:42:23Z",
"autoExecutedOn": "2019-04-03T16:42:23Z",
"isAutoExecutable": true,
"assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"note": "A dummy note",
"assignmentState": "ACCEPTED",
"state": "PLANNED",
"dateCreated": "2019-04-01T16:42:23Z",
"totalLiquidRate": 0.03,
"products": [{"uuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"applicationRate": 0.03,
"unit": "M3_KG",
"dilutionFactor": 1.3
}
],
"taskMethodUuid": "POWDERING",
"recipe": [{"uuid": "b7784b3b-1f9b-bc42-f65d-1cf9f02eaede",
"type": "PRODUCT",
"averageApplicationRate": 0.000015926667,
"totalApplication": 0.00039,
"productFormulationTypeGroup": "199067a9-5bb1-4f20-9641-a35d5ce31e19",
"name": "Test Product",
"productFormulationTypeGroupName": "LIQUID",
"organization": "Test org1, Test Org2"
}
]
}
]

Get single seed treatment task

Authorizations:

OAuth2

path Parameters

uuid

required

string <uuid>

Example: 199067a9-5bb1-4f20-9641-a35d5ce31e19

Define resource by uuid

header Parameters

If-None-Match

string

Example: "1"

ETag of the resource to fetch. If the resource is unchanged on the server it will respond with 304 Not Modified

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag

Responses

Response samples

200
400

Content type

application/json

{"uuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"creatorId": "e7dac807da134b05b58933df9df5ef44",
"lastModifierId": "e7dac807da134b05b58933df9df5ef44",
"etag": "\"1\"",
"cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"plannedDate": "2019-04-03T16:42:23Z",
"executionDate": "2019-04-03T16:42:23Z",
"autoExecutedOn": "2019-04-03T16:42:23Z",
"isAutoExecutable": true,
"assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"note": "A dummy note",
"assignmentState": "ACCEPTED",
"state": "PLANNED",
"dateCreated": "2019-04-01T16:42:23Z",
"totalLiquidRate": 0.03,
"products": [{"uuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"applicationRate": 0.03,
"unit": "M3_KG",
"dilutionFactor": 1.3
}
],
"taskMethodUuid": "POWDERING",
"recipe": [{"uuid": "b7784b3b-1f9b-bc42-f65d-1cf9f02eaede",
"type": "PRODUCT",
"averageApplicationRate": 0.000015926667,
"totalApplication": 0.00039,
"productFormulationTypeGroup": "199067a9-5bb1-4f20-9641-a35d5ce31e19",
"name": "Test Product",
"productFormulationTypeGroupName": "LIQUID",
"organization": "Test org1, Test Org2"
}
]
}

Update seed treatment task

Authorizations:

OAuth2

path Parameters

uuid

required

string <uuid>

Example: 199067a9-5bb1-4f20-9641-a35d5ce31e19

Define resource by uuid

header Parameters

If-Match

required

string

Example: "1"

ETag of the resource to update.

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag

Request Body schema: application/merge-patch+json

plannedDate	string <date-time>
executionDate	string or null <date-time>
isAutoExecutable	boolean or null
assigneeUuid	string or null <uuid> collaborator UUID, collaborators
note	string or null <= 5196 characters
assignmentState	string Enum: "ACCEPTED" "REJECTED" "UNACKNOWLEDGED" "UNASSIGNED"
totalLiquidRate	number <double> total liquid rate in m3/kg for LIQUID
	Array of objects <= 20 items Array of product limited to max of 20 products
taskMethodUuid	string Enum: "POWDERING" "LONG_DIP" "SHORT_DIP" "SPRAYING" "COATING" Task method for seed treatment. masterdata-dictionary with dict=TASKMETHOD

Responses

Request samples

Payload

Content type

application/merge-patch+json

{"plannedDate": "2019-04-03T16:42:23Z",
"executionDate": "2019-04-03T16:42:23Z",
"isAutoExecutable": true,
"assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"note": "A dummy note",
"assignmentState": "ACCEPTED",
"totalLiquidRate": 0.03,
"products": [{"uuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"applicationRate": 0.03,
"dilutionFactor": 1.3
}
],
"taskMethodUuid": "POWDERING"
}

Response samples

200
400
412
428

Content type

application/json

{"uuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"creatorId": "e7dac807da134b05b58933df9df5ef44",
"lastModifierId": "e7dac807da134b05b58933df9df5ef44",
"etag": "\"1\"",
"cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"plannedDate": "2019-04-03T16:42:23Z",
"executionDate": "2019-04-03T16:42:23Z",
"autoExecutedOn": "2019-04-03T16:42:23Z",
"isAutoExecutable": true,
"assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"note": "A dummy note",
"assignmentState": "ACCEPTED",
"state": "PLANNED",
"dateCreated": "2019-04-01T16:42:23Z",
"totalLiquidRate": 0.03,
"products": [{"uuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"applicationRate": 0.03,
"unit": "M3_KG",
"dilutionFactor": 1.3
}
],
"taskMethodUuid": "POWDERING",
"recipe": [{"uuid": "b7784b3b-1f9b-bc42-f65d-1cf9f02eaede",
"type": "PRODUCT",
"averageApplicationRate": 0.000015926667,
"totalApplication": 0.00039,
"productFormulationTypeGroup": "199067a9-5bb1-4f20-9641-a35d5ce31e19",
"name": "Test Product",
"productFormulationTypeGroupName": "LIQUID",
"organization": "Test org1, Test Org2"
}
]
}

Delete a seed treatment task

Authorizations:

OAuth2

path Parameters

uuid

required

string <uuid>

Example: 199067a9-5bb1-4f20-9641-a35d5ce31e19

Define resource by uuid

Responses

Seed Box Treatment Task

Seed Box Treatment Task for the seed of the crop to be treated before sowing.

Create a seed box treatment task

Authorizations:

OAuth2

Request Body schema: application/json

cropSeasonUuid required	string <uuid>
autoExecutedOn	string or null <date-time>
plannedDate required	string <date-time>
executionDate	string or null <date-time>
isAutoExecutable	boolean or null
assigneeUuid	string or null <uuid> collaborator UUID, collaborators
note	string or null <= 5196 characters
assignmentState	string Enum: "ACCEPTED" "REJECTED" "UNACKNOWLEDGED" "UNASSIGNED"
totalLiquidRate	number <double> total liquid rate in m3/box for LIQUID
required	Array of objects <= 20 items Array of product limited to max of 20 products
taskMethodUuid required	string <uuid> Task method uuid , masterdata-dictionary with dict=TASKMETHOD
applicationSpotUuid required	string <uuid> This is uuid of spot(e.g. SEED, FOLIAR, SOIL, FOLIARORSOIL) where treatment is applied. masterdata-dictionary with dict=APPLICATIONSPOT
totalLiquidLocalUnitUuid	string or null <uuid> Unit Id from MdUnit
waterLocalUnitUuid	string or null <uuid> Unit Id from MdUnit

Responses

Request samples

Payload

Content type

application/json

{"cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef806",
"autoExecutedOn": "2019-04-03T16:42:23Z",
"plannedDate": "2019-04-03T16:42:23Z",
"executionDate": "2019-04-03T16:42:23Z",
"isAutoExecutable": true,
"assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"note": "A dummy note",
"assignmentState": "ACCEPTED",
"totalLiquidRate": 0.03,
"products": [{"uuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"applicationRate": 0.03,
"localUnitUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"dilutionFactor": 1.3
}
],
"taskMethodUuid": "a8cd4c5a-392d-4685-89df-b4e5df09954c",
"applicationSpotUuid": "58cd4c5a-392d-4685-89df-b4e5df09954a",
"totalLiquidLocalUnitUuid": "bedc4521-6797-4f57-8437-a539c5dea0b1",
"waterLocalUnitUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80"
}

Response samples

201
400

Content type

application/json

{"uuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"creatorId": "e7dac807da134b05b58933df9df5ef44",
"lastModifierId": "e7dac807da134b05b58933df9df5ef44",
"etag": "\"1\"",
"cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"plannedDate": "2019-04-03T16:42:23Z",
"executionDate": "2019-04-03T16:42:23Z",
"autoExecutedOn": "2019-04-03T16:42:23Z",
"isAutoExecutable": true,
"assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"note": "A dummy note",
"assignmentState": "ACCEPTED",
"state": "PLANNED",
"dateCreated": "2019-04-01T16:42:23Z",
"totalLiquidRate": 0.03,
"products": [{"uuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"applicationRate": 0.03,
"unit": "M3_BOX",
"localUnitUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"dilutionFactor": 1.3
}
],
"taskMethodUuid": "a8cd4c5a-392d-4685-89df-b4e5df09954c",
"applicationSpotUuid": "58cd4c5a-392d-4685-89df-b4e5df09954a",
"recipe": [{"uuid": "b7784b3b-1f9b-bc42-f65d-1cf9f02eaede",
"type": "PRODUCT",
"averageApplicationRate": 0.000015926667,
"totalApplication": 0.00039,
"productFormulationTypeGroup": "199067a9-5bb1-4f20-9641-a35d5ce31e19",
"name": "Test Product",
"productFormulationTypeGroupName": "LIQUID",
"organization": "Test org1, Test Org2"
}
],
"totalLiquidLocalUnitUuid": "bedc4521-6797-4f57-8437-a539c5dea0b1",
"waterLocalUnitUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80"
}

Get seed box treatment tasks

Authorizations:

OAuth2

query Parameters

uuid	Array of strings <uuid> Example: uuid=199067a9-5bb1-4f20-9641-a35d5ce31e19 Filter by resource uuid
cropSeasonUuid	Array of strings <uuid> Example: cropSeasonUuid=2a84e031-c5c6-4fcf-95f6-1341c5ebef80 Filter by cropseason uuid

Responses

Response samples

200
400

Content type

application/json

[{"uuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"creatorId": "e7dac807da134b05b58933df9df5ef44",
"lastModifierId": "e7dac807da134b05b58933df9df5ef44",
"etag": "\"1\"",
"cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"plannedDate": "2019-04-03T16:42:23Z",
"executionDate": "2019-04-03T16:42:23Z",
"autoExecutedOn": "2019-04-03T16:42:23Z",
"isAutoExecutable": true,
"assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"note": "A dummy note",
"assignmentState": "ACCEPTED",
"state": "PLANNED",
"dateCreated": "2019-04-01T16:42:23Z",
"totalLiquidRate": 0.03,
"products": [{"uuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"applicationRate": 0.03,
"unit": "M3_BOX",
"localUnitUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"dilutionFactor": 1.3
}
],
"taskMethodUuid": "a8cd4c5a-392d-4685-89df-b4e5df09954c",
"applicationSpotUuid": "58cd4c5a-392d-4685-89df-b4e5df09954a",
"recipe": [{"uuid": "b7784b3b-1f9b-bc42-f65d-1cf9f02eaede",
"type": "PRODUCT",
"averageApplicationRate": 0.000015926667,
"totalApplication": 0.00039,
"productFormulationTypeGroup": "199067a9-5bb1-4f20-9641-a35d5ce31e19",
"name": "Test Product",
"productFormulationTypeGroupName": "LIQUID",
"organization": "Test org1, Test Org2"
}
],
"totalLiquidLocalUnitUuid": "bedc4521-6797-4f57-8437-a539c5dea0b1",
"waterLocalUnitUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80"
}
]

Get single seed box treatment task

Authorizations:

OAuth2

path Parameters

uuid

required

string <uuid>

Example: 199067a9-5bb1-4f20-9641-a35d5ce31e19

Define resource by uuid

header Parameters

If-None-Match

string

Example: "1"

ETag of the resource to fetch. If the resource is unchanged on the server it will respond with 304 Not Modified

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag

Responses

Response samples

200
400

Content type

application/json

{"uuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"creatorId": "e7dac807da134b05b58933df9df5ef44",
"lastModifierId": "e7dac807da134b05b58933df9df5ef44",
"etag": "\"1\"",
"cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"plannedDate": "2019-04-03T16:42:23Z",
"executionDate": "2019-04-03T16:42:23Z",
"autoExecutedOn": "2019-04-03T16:42:23Z",
"isAutoExecutable": true,
"assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"note": "A dummy note",
"assignmentState": "ACCEPTED",
"state": "PLANNED",
"dateCreated": "2019-04-01T16:42:23Z",
"totalLiquidRate": 0.03,
"products": [{"uuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"applicationRate": 0.03,
"unit": "M3_BOX",
"localUnitUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"dilutionFactor": 1.3
}
],
"taskMethodUuid": "a8cd4c5a-392d-4685-89df-b4e5df09954c",
"applicationSpotUuid": "58cd4c5a-392d-4685-89df-b4e5df09954a",
"recipe": [{"uuid": "b7784b3b-1f9b-bc42-f65d-1cf9f02eaede",
"type": "PRODUCT",
"averageApplicationRate": 0.000015926667,
"totalApplication": 0.00039,
"productFormulationTypeGroup": "199067a9-5bb1-4f20-9641-a35d5ce31e19",
"name": "Test Product",
"productFormulationTypeGroupName": "LIQUID",
"organization": "Test org1, Test Org2"
}
],
"totalLiquidLocalUnitUuid": "bedc4521-6797-4f57-8437-a539c5dea0b1",
"waterLocalUnitUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80"
}

Update seed box treatment task

Authorizations:

OAuth2

path Parameters

uuid

required

string <uuid>

Example: 199067a9-5bb1-4f20-9641-a35d5ce31e19

Define resource by uuid

header Parameters

If-Match

required

string

Example: "1"

ETag of the resource to update.

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag

Request Body schema: application/merge-patch+json

plannedDate	string <date-time>
executionDate	string or null <date-time>
isAutoExecutable	boolean or null
assigneeUuid	string or null <uuid> collaborator UUID, collaborators
note	string or null <= 5196 characters
assignmentState	string Enum: "ACCEPTED" "REJECTED" "UNACKNOWLEDGED" "UNASSIGNED"
totalLiquidRate	number <double> total liquid rate in m3/box for LIQUID
	Array of objects <= 20 items Array of product limited to max of 20 products
taskMethodUuid	string <uuid> Task method uuid , masterdata-dictionary with dict=TASKMETHOD
applicationSpotUuid	string <uuid> This is uuid of spot(e.g. SEED, FOLIAR, SOIL, FOLIARORSOIL) where treatment is applied. masterdata-dictionary with dict=APPLICATIONSPOT
totalLiquidLocalUnitUuid	string or null <uuid> Unit Id from MdUnit
waterLocalUnitUuid	string or null <uuid> Unit Id from MdUnit

Responses

Request samples

Payload

Content type

application/merge-patch+json

{"plannedDate": "2019-04-03T16:42:23Z",
"executionDate": "2019-04-03T16:42:23Z",
"isAutoExecutable": true,
"assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"note": "A dummy note",
"assignmentState": "ACCEPTED",
"totalLiquidRate": 0.03,
"products": [{"uuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"applicationRate": 0.03,
"localUnitUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"dilutionFactor": 1.3
}
],
"taskMethodUuid": "a8cd4c5a-392d-4685-89df-b4e5df09954c",
"applicationSpotUuid": "58cd4c5a-392d-4685-89df-b4e5df09954a",
"totalLiquidLocalUnitUuid": "bedc4521-6797-4f57-8437-a539c5dea0b1",
"waterLocalUnitUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80"
}

Response samples

200
400
412
428

Content type

application/json

{"uuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"creatorId": "e7dac807da134b05b58933df9df5ef44",
"lastModifierId": "e7dac807da134b05b58933df9df5ef44",
"etag": "\"1\"",
"cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"plannedDate": "2019-04-03T16:42:23Z",
"executionDate": "2019-04-03T16:42:23Z",
"autoExecutedOn": "2019-04-03T16:42:23Z",
"isAutoExecutable": true,
"assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"note": "A dummy note",
"assignmentState": "ACCEPTED",
"state": "PLANNED",
"dateCreated": "2019-04-01T16:42:23Z",
"totalLiquidRate": 0.03,
"products": [{"uuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"applicationRate": 0.03,
"unit": "M3_BOX",
"localUnitUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"dilutionFactor": 1.3
}
],
"taskMethodUuid": "a8cd4c5a-392d-4685-89df-b4e5df09954c",
"applicationSpotUuid": "58cd4c5a-392d-4685-89df-b4e5df09954a",
"recipe": [{"uuid": "b7784b3b-1f9b-bc42-f65d-1cf9f02eaede",
"type": "PRODUCT",
"averageApplicationRate": 0.000015926667,
"totalApplication": 0.00039,
"productFormulationTypeGroup": "199067a9-5bb1-4f20-9641-a35d5ce31e19",
"name": "Test Product",
"productFormulationTypeGroupName": "LIQUID",
"organization": "Test org1, Test Org2"
}
],
"totalLiquidLocalUnitUuid": "bedc4521-6797-4f57-8437-a539c5dea0b1",
"waterLocalUnitUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80"
}

Delete a seed box treatment task

Authorizations:

OAuth2

path Parameters

uuid

required

string <uuid>

Example: 199067a9-5bb1-4f20-9641-a35d5ce31e19

Define resource by uuid

Responses

Land preparations task

Get land preparations tasks using the filter

Authorizations:

OAuth2

query Parameters

uuid	Array of strings <uuid> Example: uuid=199067a9-5bb1-4f20-9641-a35d5ce31e19 Filter by resource uuid
cropSeasonUuid	Array of strings <uuid> Example: cropSeasonUuid=2a84e031-c5c6-4fcf-95f6-1341c5ebef80 Filter by cropseason uuid

Responses

Response samples

200
400

Content type

application/json

[{"uuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"creatorId": "e7dac807da134b05b58933df9df5ef44",
"lastModifierId": "e7dac807da134b05b58933df9df5ef44",
"etag": "\"1\"",
"cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"plannedDate": "2019-04-03T16:42:23Z",
"executionDate": "2019-04-03T16:42:23Z",
"autoExecutedOn": "2019-04-03T16:42:23Z",
"isAutoExecutable": true,
"assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"note": "A dummy note",
"assignmentState": "ACCEPTED",
"state": "PLANNED",
"dateCreated": "2019-04-01T16:42:23Z",
"tillageUuid": "a8cd4c5a-392d-4685-89df-b4e5df09954c",
"drainagePreparationUuid": "58cd4c5a-392d-4685-89df-b4e5df09954a",
"tillageDepth": 14.3,
"processedArea": 121.3
}
]

Create a land preparation task

At least one of tillageUuid or drainagePreparationUuid is mandatory.

Authorizations:

OAuth2

Request Body schema: application/json

cropSeasonUuid required	string <uuid>
autoExecutedOn	string or null <date-time>
plannedDate required	string <date-time>
executionDate	string or null <date-time>
isAutoExecutable	boolean or null
assigneeUuid	string or null <uuid> collaborator UUID, collaborators
note	string or null <= 5196 characters
assignmentState	string Enum: "ACCEPTED" "REJECTED" "UNACKNOWLEDGED" "UNASSIGNED"
tillageUuid	string <uuid> Tillage uuid, masterdata-tillagesystem.
drainagePreparationUuid	string <uuid> This is uuid of drainage preparation. masterdata-dictionary with dict=DRAINAGEPREPARATION
tillageDepth	number or null <double> >= 0 Unit to measure tillageDepth is meters
processedArea	number or null <double> >= 0 Area that was processed in the land preparation

Responses

Request samples

Payload

Content type

application/json

{"cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef806",
"autoExecutedOn": "2019-04-03T16:42:23Z",
"plannedDate": "2019-04-03T16:42:23Z",
"executionDate": "2019-04-03T16:42:23Z",
"isAutoExecutable": true,
"assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"note": "A dummy note",
"assignmentState": "ACCEPTED",
"tillageUuid": "a8cd4c5a-392d-4685-89df-b4e5df09954c",
"drainagePreparationUuid": "58cd4c5a-392d-4685-89df-b4e5df09954a",
"tillageDepth": 14.3,
"processedArea": 121.3
}

Response samples

200
400
412
428

Content type

application/json

{"uuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"creatorId": "e7dac807da134b05b58933df9df5ef44",
"lastModifierId": "e7dac807da134b05b58933df9df5ef44",
"etag": "\"1\"",
"cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"plannedDate": "2019-04-03T16:42:23Z",
"executionDate": "2019-04-03T16:42:23Z",
"autoExecutedOn": "2019-04-03T16:42:23Z",
"isAutoExecutable": true,
"assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"note": "A dummy note",
"assignmentState": "ACCEPTED",
"state": "PLANNED",
"dateCreated": "2019-04-01T16:42:23Z",
"tillageUuid": "a8cd4c5a-392d-4685-89df-b4e5df09954c",
"drainagePreparationUuid": "58cd4c5a-392d-4685-89df-b4e5df09954a",
"tillageDepth": 14.3,
"processedArea": 121.3
}

Patch an existing land preparation task

Authorizations:

OAuth2

path Parameters

uuid

required

string <uuid>

Example: 199067a9-5bb1-4f20-9641-a35d5ce31e19

Define resource by uuid

header Parameters

If-Match

required

string

Example: "1"

ETag of the resource to update.

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag

Request Body schema: application/merge-patch+json

plannedDate	string <date-time>
executionDate	string or null <date-time>
isAutoExecutable	boolean or null
assigneeUuid	string or null <uuid> collaborator UUID, collaborators
note	string or null <= 5196 characters
assignmentState	string Enum: "ACCEPTED" "REJECTED" "UNACKNOWLEDGED" "UNASSIGNED"
tillageUuid	string <uuid> Tillage uuid, masterdata-tillagesystem.
drainagePreparationUuid	string <uuid> This is uuid of drainage preparation. masterdata-dictionary with dict=DRAINAGEPREPARATION
tillageDepth	number or null <double> >= 0 Unit to measure tillageDepth is meters
processedArea	number or null <double> >= 0 Area that was processed in the land preparation

Responses

Request samples

Payload

Content type

application/merge-patch+json

{"plannedDate": "2019-04-03T16:42:23Z",
"executionDate": "2019-04-03T16:42:23Z",
"isAutoExecutable": true,
"assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"note": "A dummy note",
"assignmentState": "ACCEPTED",
"tillageUuid": "a8cd4c5a-392d-4685-89df-b4e5df09954c",
"drainagePreparationUuid": "58cd4c5a-392d-4685-89df-b4e5df09954a",
"tillageDepth": 14.3,
"processedArea": 121.3
}

Response samples

200
400
412
428

Content type

application/json

{"uuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"creatorId": "e7dac807da134b05b58933df9df5ef44",
"lastModifierId": "e7dac807da134b05b58933df9df5ef44",
"etag": "\"1\"",
"cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"plannedDate": "2019-04-03T16:42:23Z",
"executionDate": "2019-04-03T16:42:23Z",
"autoExecutedOn": "2019-04-03T16:42:23Z",
"isAutoExecutable": true,
"assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"note": "A dummy note",
"assignmentState": "ACCEPTED",
"state": "PLANNED",
"dateCreated": "2019-04-01T16:42:23Z",
"tillageUuid": "a8cd4c5a-392d-4685-89df-b4e5df09954c",
"drainagePreparationUuid": "58cd4c5a-392d-4685-89df-b4e5df09954a",
"tillageDepth": 14.3,
"processedArea": 121.3
}

Get a land preparation by uuid

Authorizations:

OAuth2

path Parameters

uuid

required

string <uuid>

Example: 199067a9-5bb1-4f20-9641-a35d5ce31e19

Define resource by uuid

header Parameters

If-None-Match

string

Example: "1"

ETag of the resource to fetch. If the resource is unchanged on the server it will respond with 304 Not Modified

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag

Responses

Response samples

200
400

Content type

application/json

{"uuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"creatorId": "e7dac807da134b05b58933df9df5ef44",
"lastModifierId": "e7dac807da134b05b58933df9df5ef44",
"etag": "\"1\"",
"cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"plannedDate": "2019-04-03T16:42:23Z",
"executionDate": "2019-04-03T16:42:23Z",
"autoExecutedOn": "2019-04-03T16:42:23Z",
"isAutoExecutable": true,
"assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"note": "A dummy note",
"assignmentState": "ACCEPTED",
"state": "PLANNED",
"dateCreated": "2019-04-01T16:42:23Z",
"tillageUuid": "a8cd4c5a-392d-4685-89df-b4e5df09954c",
"drainagePreparationUuid": "58cd4c5a-392d-4685-89df-b4e5df09954a",
"tillageDepth": 14.3,
"processedArea": 121.3
}

Delete a land preparation task

Authorizations:

OAuth2

path Parameters

uuid

required

string <uuid>

Example: 199067a9-5bb1-4f20-9641-a35d5ce31e19

Define resource by uuid

Responses

Crop Residue Management Task

Crop Residue Management Task for straw management

Get crop residue management tasks using the filter

Authorizations:

OAuth2

query Parameters

uuid	Array of strings <uuid> Example: uuid=199067a9-5bb1-4f20-9641-a35d5ce31e19 Filter by resource uuid
cropSeasonUuid	Array of strings <uuid> Example: cropSeasonUuid=2a84e031-c5c6-4fcf-95f6-1341c5ebef80 Filter by cropseason uuid

Responses

Response samples

200
400

Content type

application/json

[{"uuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"creatorId": "e7dac807da134b05b58933df9df5ef44",
"lastModifierId": "e7dac807da134b05b58933df9df5ef44",
"etag": "\"1\"",
"cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"plannedDate": "2019-04-03T16:42:23Z",
"executionDate": "2019-04-03T16:42:23Z",
"autoExecutedOn": "2019-04-03T16:42:23Z",
"isAutoExecutable": true,
"assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"note": "A dummy note",
"assignmentState": "ACCEPTED",
"state": "PLANNED",
"dateCreated": "2019-04-01T16:42:23Z",
"residueManagementUuid": "a8cd4c5a-392d-4685-89df-b4e5df09954c",
"area": 14.3
}
]

Create a crop residue management task

Creates a crop residue management task, cropSeasonUuid is mandatory.

Authorizations:

OAuth2

Request Body schema: application/json

cropSeasonUuid required	string <uuid>
autoExecutedOn	string or null <date-time>
plannedDate required	string <date-time>
executionDate	string or null <date-time>
isAutoExecutable	boolean or null
assigneeUuid	string or null <uuid> collaborator UUID, collaborators
note	string or null <= 5196 characters
assignmentState	string Enum: "ACCEPTED" "REJECTED" "UNACKNOWLEDGED" "UNASSIGNED"
residueManagementUuid	string <uuid> Residue management uuid
area	number or null <double> >= 0 Area of the crop residue management task. If it's present it needs to be positive and less then Field area.

Responses

Request samples

Payload

Content type

application/json

{"cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef806",
"autoExecutedOn": "2019-04-03T16:42:23Z",
"plannedDate": "2019-04-03T16:42:23Z",
"executionDate": "2019-04-03T16:42:23Z",
"isAutoExecutable": true,
"assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"note": "A dummy note",
"assignmentState": "ACCEPTED",
"residueManagementUuid": "a8cd4c5a-392d-4685-89df-b4e5df09954c",
"area": 14.3
}

Response samples

200
400
412
428

Content type

application/json

{"uuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"creatorId": "e7dac807da134b05b58933df9df5ef44",
"lastModifierId": "e7dac807da134b05b58933df9df5ef44",
"etag": "\"1\"",
"cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"plannedDate": "2019-04-03T16:42:23Z",
"executionDate": "2019-04-03T16:42:23Z",
"autoExecutedOn": "2019-04-03T16:42:23Z",
"isAutoExecutable": true,
"assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"note": "A dummy note",
"assignmentState": "ACCEPTED",
"state": "PLANNED",
"dateCreated": "2019-04-01T16:42:23Z",
"residueManagementUuid": "a8cd4c5a-392d-4685-89df-b4e5df09954c",
"area": 14.3
}

Patch an existing crop residue management task

Authorizations:

OAuth2

path Parameters

uuid

required

string <uuid>

Example: 199067a9-5bb1-4f20-9641-a35d5ce31e19

Define resource by uuid

header Parameters

If-Match

required

string

Example: "1"

ETag of the resource to update.

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag

Request Body schema: application/merge-patch+json

plannedDate	string <date-time>
executionDate	string or null <date-time>
isAutoExecutable	boolean or null
assigneeUuid	string or null <uuid> collaborator UUID, collaborators
note	string or null <= 5196 characters
assignmentState	string Enum: "ACCEPTED" "REJECTED" "UNACKNOWLEDGED" "UNASSIGNED"
residueManagementUuid	string <uuid> Residue management uuid
area	number or null <double> >= 0 Area of the crop residue management task. If it's present it needs to be positive and less then Field area.

Responses

Request samples

Payload

Content type

application/merge-patch+json

{"plannedDate": "2019-04-03T16:42:23Z",
"executionDate": "2019-04-03T16:42:23Z",
"isAutoExecutable": true,
"assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"note": "A dummy note",
"assignmentState": "ACCEPTED",
"residueManagementUuid": "a8cd4c5a-392d-4685-89df-b4e5df09954c",
"area": 14.3
}

Response samples

200
400
412
428

Content type

application/json

{"uuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"creatorId": "e7dac807da134b05b58933df9df5ef44",
"lastModifierId": "e7dac807da134b05b58933df9df5ef44",
"etag": "\"1\"",
"cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"plannedDate": "2019-04-03T16:42:23Z",
"executionDate": "2019-04-03T16:42:23Z",
"autoExecutedOn": "2019-04-03T16:42:23Z",
"isAutoExecutable": true,
"assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"note": "A dummy note",
"assignmentState": "ACCEPTED",
"state": "PLANNED",
"dateCreated": "2019-04-01T16:42:23Z",
"residueManagementUuid": "a8cd4c5a-392d-4685-89df-b4e5df09954c",
"area": 14.3
}

Get a crop residue management task by uuid

Authorizations:

OAuth2

path Parameters

uuid

required

string <uuid>

Example: 199067a9-5bb1-4f20-9641-a35d5ce31e19

Define resource by uuid

header Parameters

If-None-Match

string

Example: "1"

ETag of the resource to fetch. If the resource is unchanged on the server it will respond with 304 Not Modified

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag

Responses

Response samples

200
400

Content type

application/json

{"uuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"creatorId": "e7dac807da134b05b58933df9df5ef44",
"lastModifierId": "e7dac807da134b05b58933df9df5ef44",
"etag": "\"1\"",
"cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"plannedDate": "2019-04-03T16:42:23Z",
"executionDate": "2019-04-03T16:42:23Z",
"autoExecutedOn": "2019-04-03T16:42:23Z",
"isAutoExecutable": true,
"assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"note": "A dummy note",
"assignmentState": "ACCEPTED",
"state": "PLANNED",
"dateCreated": "2019-04-01T16:42:23Z",
"residueManagementUuid": "a8cd4c5a-392d-4685-89df-b4e5df09954c",
"area": 14.3
}

Delete a crop residue management task

Authorizations:

OAuth2

path Parameters

uuid

required

string <uuid>

Example: 199067a9-5bb1-4f20-9641-a35d5ce31e19

Define resource by uuid

Responses

harvest

Get harvest using the filter.

Authorizations:

OAuth2

query Parameters

uuid	Array of strings <uuid> Example: uuid=199067a9-5bb1-4f20-9641-a35d5ce31e19 Filter by resource uuid
cropSeasonUuid	Array of strings <uuid> Example: cropSeasonUuid=2a84e031-c5c6-4fcf-95f6-1341c5ebef80 Filter by cropseason uuid

Responses

Response samples

200
400

Content type

application/json

[{"uuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"creatorId": "e7dac807da134b05b58933df9df5ef44",
"lastModifierId": "e7dac807da134b05b58933df9df5ef44",
"etag": "\"1\"",
"cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"plannedDate": "2019-04-03T16:42:23Z",
"executionDate": "2019-04-03T16:42:23Z",
"autoExecutedOn": "2019-04-03T16:42:23Z",
"isAutoExecutable": true,
"assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"note": "A dummy note",
"assignmentState": "ACCEPTED",
"state": "PLANNED",
"dateCreated": "2019-04-01T16:42:23Z",
"yieldProperties": {"MOISTURE_PERCENT": 100,
"PROTEIN_PERCENT": 100,
"OIL_PERCENT": 100,
"SUGAR_PERCENT": 100,
"STARCH_PERCENT": 100,
"TGW_G": 0,
"HLW_KG": 0,
"DON": 0,
"ZEA": 0,
"NEL": 0
},
"harvestMethodCode": "PLUCK",
"harvestMethodUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"harvestedProduceCode": "GRAIN",
"yield": 1.2,
"isSingleHarvestOnly": true,
"processedArea": 121.3
}
]

Create a harvest

Authorizations:

OAuth2

Request Body schema: application/json

cropSeasonUuid required	string <uuid>
plannedDate required	string <date-time>
executionDate	string or null <date-time>
isAutoExecutable	boolean or null
assigneeUuid	string or null <uuid> collaborator UUID, collaborators
note	string or null <= 5196 characters
assignmentState	string Enum: "ACCEPTED" "REJECTED" "UNACKNOWLEDGED" "UNASSIGNED"
	object Values will dependent on country and crop combination.
harvestMethodCode	string Deprecated Enum: "MACHINE" "CUT" "PLUCK" "PICK" "HANDCUT" "HANDPLUCK" "HANDPICK" "ROLLER_MECHANICAL_DESTRUCTION" "GRAZING" "COMBINE_STRAW_REMOVAL" "COMBINE_STRAW_INCORPORATION" "HARVESTER" "HARVESTER2STAGE" "FORAGERSDIRECTCUTTING" "MOWERCOMBINATION" "MAIZECHOPPER" "HARVESTERGRAIN" "HARVESTERCCM" "HARVESTERCOB" please, use harvestMethodUuid instead - will not be accepted anymore, returns 400 Bad Request
harvestMethodUuid	string or null <uuid> Harvest method uuid , masterdata-dictionary with dict=HARVESTMETHOD
harvestedProduceCode	string Enum: "PLANT" "CCM" "GRAIN" "FRUIT" "FRUITFALL" "STRAW" "HAY" "CROP"
yield	number <double> Always MASS/AREA kg/m2. This is the average yield for the field.
processedArea	number or null <double> >= 0 Area that was processed in the harvest task. Cannot be greater than the crop season area.

Responses

Request samples

Payload

Content type

application/json

{"cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef806",
"plannedDate": "2019-04-03T16:42:23Z",
"executionDate": "2019-04-03T16:42:23Z",
"isAutoExecutable": true,
"assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"note": "A dummy note",
"assignmentState": "ACCEPTED",
"yieldProperties": {"MOISTURE_PERCENT": 100,
"PROTEIN_PERCENT": 100,
"OIL_PERCENT": 100,
"SUGAR_PERCENT": 100,
"STARCH_PERCENT": 100,
"TGW_G": 0,
"HLW_KG": 0,
"DON": 0,
"ZEA": 0,
"NEL": 0
},
"harvestMethodCode": "PLUCK",
"harvestMethodUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"harvestedProduceCode": "GRAIN",
"yield": 1.2,
"processedArea": 121.3
}

Response samples

200
400

Content type

application/json

{"uuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"creatorId": "e7dac807da134b05b58933df9df5ef44",
"lastModifierId": "e7dac807da134b05b58933df9df5ef44",
"etag": "\"1\"",
"cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"plannedDate": "2019-04-03T16:42:23Z",
"executionDate": "2019-04-03T16:42:23Z",
"autoExecutedOn": "2019-04-03T16:42:23Z",
"isAutoExecutable": true,
"assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"note": "A dummy note",
"assignmentState": "ACCEPTED",
"state": "PLANNED",
"dateCreated": "2019-04-01T16:42:23Z",
"yieldProperties": {"MOISTURE_PERCENT": 100,
"PROTEIN_PERCENT": 100,
"OIL_PERCENT": 100,
"SUGAR_PERCENT": 100,
"STARCH_PERCENT": 100,
"TGW_G": 0,
"HLW_KG": 0,
"DON": 0,
"ZEA": 0,
"NEL": 0
},
"harvestMethodCode": "PLUCK",
"harvestMethodUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"harvestedProduceCode": "GRAIN",
"yield": 1.2,
"isSingleHarvestOnly": true,
"processedArea": 121.3
}

Patch an existing harvest

Authorizations:

OAuth2

path Parameters

uuid

required

string <uuid>

Example: 199067a9-5bb1-4f20-9641-a35d5ce31e19

Define resource by uuid

header Parameters

If-Match

required

string

Example: "1"

ETag of the resource to update.

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag

Request Body schema: application/merge-patch+json

plannedDate	string <date-time>
executionDate	string or null <date-time>
isAutoExecutable	boolean or null
assigneeUuid	string or null <uuid> collaborator UUID, collaborators
note	string or null <= 5196 characters
assignmentState	string Enum: "ACCEPTED" "REJECTED" "UNACKNOWLEDGED" "UNASSIGNED"
	object Values will dependent on country and crop combination.
harvestMethodCode	string Deprecated Enum: "MACHINE" "CUT" "PLUCK" "PICK" "HANDCUT" "HANDPLUCK" "HANDPICK" "ROLLER_MECHANICAL_DESTRUCTION" "GRAZING" "COMBINE_STRAW_REMOVAL" "COMBINE_STRAW_INCORPORATION" "HARVESTER" "HARVESTER2STAGE" "FORAGERSDIRECTCUTTING" "MOWERCOMBINATION" "MAIZECHOPPER" "HARVESTERGRAIN" "HARVESTERCCM" "HARVESTERCOB" please, use harvestMethodUuid instead - will not be accepted anymore, returns 400 Bad Request
harvestMethodUuid	string or null <uuid> Harvest method uuid , masterdata-dictionary with dict=HARVESTMETHOD
harvestedProduceCode	string Enum: "PLANT" "CCM" "GRAIN" "FRUIT" "FRUITFALL" "STRAW" "HAY" "CROP"
yield	number <double> Always MASS/AREA kg/m2. This is the average yield for the field.
processedArea	number or null <double> >= 0 Area that was processed in the harvest task. Cannot be greater than the crop season area.

Responses

Request samples

Payload

Content type

application/merge-patch+json

{"plannedDate": "2019-04-03T16:42:23Z",
"executionDate": "2019-04-03T16:42:23Z",
"isAutoExecutable": true,
"assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"note": "A dummy note",
"assignmentState": "ACCEPTED",
"yieldProperties": {"MOISTURE_PERCENT": 100,
"PROTEIN_PERCENT": 100,
"OIL_PERCENT": 100,
"SUGAR_PERCENT": 100,
"STARCH_PERCENT": 100,
"TGW_G": 0,
"HLW_KG": 0,
"DON": 0,
"ZEA": 0,
"NEL": 0
},
"harvestMethodCode": "PLUCK",
"harvestMethodUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"harvestedProduceCode": "GRAIN",
"yield": 1.2,
"processedArea": 121.3
}

Response samples

200
400
412
428

Content type

application/json

{"uuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"creatorId": "e7dac807da134b05b58933df9df5ef44",
"lastModifierId": "e7dac807da134b05b58933df9df5ef44",
"etag": "\"1\"",
"cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"plannedDate": "2019-04-03T16:42:23Z",
"executionDate": "2019-04-03T16:42:23Z",
"autoExecutedOn": "2019-04-03T16:42:23Z",
"isAutoExecutable": true,
"assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"note": "A dummy note",
"assignmentState": "ACCEPTED",
"state": "PLANNED",
"dateCreated": "2019-04-01T16:42:23Z",
"yieldProperties": {"MOISTURE_PERCENT": 100,
"PROTEIN_PERCENT": 100,
"OIL_PERCENT": 100,
"SUGAR_PERCENT": 100,
"STARCH_PERCENT": 100,
"TGW_G": 0,
"HLW_KG": 0,
"DON": 0,
"ZEA": 0,
"NEL": 0
},
"harvestMethodCode": "PLUCK",
"harvestMethodUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"harvestedProduceCode": "GRAIN",
"yield": 1.2,
"isSingleHarvestOnly": true,
"processedArea": 121.3
}

Get a harvest by uuid

Authorizations:

OAuth2

path Parameters

uuid

required

string <uuid>

Example: 199067a9-5bb1-4f20-9641-a35d5ce31e19

Define resource by uuid

header Parameters

If-None-Match

string

Example: "1"

ETag of the resource to fetch. If the resource is unchanged on the server it will respond with 304 Not Modified

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag

Responses

Response samples

200
400

Content type

application/json

{"uuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"creatorId": "e7dac807da134b05b58933df9df5ef44",
"lastModifierId": "e7dac807da134b05b58933df9df5ef44",
"etag": "\"1\"",
"cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"plannedDate": "2019-04-03T16:42:23Z",
"executionDate": "2019-04-03T16:42:23Z",
"autoExecutedOn": "2019-04-03T16:42:23Z",
"isAutoExecutable": true,
"assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"note": "A dummy note",
"assignmentState": "ACCEPTED",
"state": "PLANNED",
"dateCreated": "2019-04-01T16:42:23Z",
"yieldProperties": {"MOISTURE_PERCENT": 100,
"PROTEIN_PERCENT": 100,
"OIL_PERCENT": 100,
"SUGAR_PERCENT": 100,
"STARCH_PERCENT": 100,
"TGW_G": 0,
"HLW_KG": 0,
"DON": 0,
"ZEA": 0,
"NEL": 0
},
"harvestMethodCode": "PLUCK",
"harvestMethodUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"harvestedProduceCode": "GRAIN",
"yield": 1.2,
"isSingleHarvestOnly": true,
"processedArea": 121.3
}

Delete a harvest.

Authorizations:

OAuth2

path Parameters

uuid

required

string <uuid>

Example: 199067a9-5bb1-4f20-9641-a35d5ce31e19

Define resource by uuid

Responses

Soil Sampling tasks

Get soil sampling tasks using the filter

At least one of parameters are required.

Authorizations:

OAuth2

query Parameters

uuid	Array of strings <uuid> Example: uuid=199067a9-5bb1-4f20-9641-a35d5ce31e19 Filter by resource uuid
cropSeasonUuid	Array of strings <uuid> Example: cropSeasonUuid=2a84e031-c5c6-4fcf-95f6-1341c5ebef80 Filter by cropseason uuid
soilSamplingSetUuid	Array of strings <uuid> Example: soilSamplingSetUuid=3a84e031-c5c6-4fcf-95f6-1341c5ebef80 Filter by soilSamplingSet uuid

Responses

Response samples

200
400

Content type

application/json

[{"uuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"creatorId": "e7dac807da134b05b58933df9df5ef44",
"lastModifierId": "e7dac807da134b05b58933df9df5ef44",
"etag": "\"1\"",
"cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"soilSamplingSetUuid": "3a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"sampledPoints": [{"geometry": {"type": "Point",
"coordinates": [7.2263968,
53.5531078
]
}
}
],
"plannedDate": "2019-04-03T16:42:23Z",
"executionDate": "2019-04-03T16:42:23Z",
"assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"note": "A dummy note",
"assignmentState": "ACCEPTED",
"state": "PLANNED"
}
]

Create a soil sampling task

Authorizations:

OAuth2

Request Body schema: application/json

cropSeasonUuid required	string <uuid>
soilSamplingSetUuid required	string <uuid> uuid of the soil sampling, soil-samplings
	Array of objects or null
plannedDate required	string <date-time>
executionDate	string or null <date-time>
assigneeUuid	string or null <uuid> collaborator UUID, collaborators
note	string or null <= 5196 characters
assignmentState	string Enum: "ACCEPTED" "REJECTED" "UNACKNOWLEDGED" "UNASSIGNED"

Responses

Request samples

Payload

Content type

application/json

{"cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef806",
"soilSamplingSetUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef806",
"sampledPoints": [{"geometry": {"type": "Point",
"coordinates": [7.2263968,
53.5531078
]
}
}
],
"plannedDate": "2019-04-03T16:42:23Z",
"executionDate": "2019-04-03T16:42:23Z",
"assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"note": "A dummy note",
"assignmentState": "ACCEPTED"
}

Response samples

200
400
412
428

Content type

application/json

{"uuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"creatorId": "e7dac807da134b05b58933df9df5ef44",
"lastModifierId": "e7dac807da134b05b58933df9df5ef44",
"etag": "\"1\"",
"cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"soilSamplingSetUuid": "3a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"sampledPoints": [{"geometry": {"type": "Point",
"coordinates": [7.2263968,
53.5531078
]
}
}
],
"plannedDate": "2019-04-03T16:42:23Z",
"executionDate": "2019-04-03T16:42:23Z",
"assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"note": "A dummy note",
"assignmentState": "ACCEPTED",
"state": "PLANNED"
}

Patch an existing soil sampling task

Authorizations:

OAuth2

path Parameters

uuid

required

string <uuid>

Example: 199067a9-5bb1-4f20-9641-a35d5ce31e19

Define resource by uuid

header Parameters

If-Match

required

string

Example: "1"

ETag of the resource to update.

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag

Request Body schema: application/merge-patch+json

	Array of objects or null
plannedDate	string <date-time>
executionDate	string or null <date-time>
assigneeUuid	string or null <uuid> collaborator UUID, collaborators
note	string or null <= 5196 characters
assignmentState	string Enum: "ACCEPTED" "REJECTED" "UNACKNOWLEDGED" "UNASSIGNED"

Responses

Request samples

Payload

Content type

application/merge-patch+json

{"sampledPoints": [{"geometry": {"type": "Point",
"coordinates": [7.2263968,
53.5531078
]
}
}
],
"plannedDate": "2019-04-03T16:42:23Z",
"executionDate": "2019-04-03T16:42:23Z",
"assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"note": "A dummy note",
"assignmentState": "ACCEPTED"
}

Response samples

200
400
412
428

Content type

application/json

{"uuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"creatorId": "e7dac807da134b05b58933df9df5ef44",
"lastModifierId": "e7dac807da134b05b58933df9df5ef44",
"etag": "\"1\"",
"cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"soilSamplingSetUuid": "3a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"sampledPoints": [{"geometry": {"type": "Point",
"coordinates": [7.2263968,
53.5531078
]
}
}
],
"plannedDate": "2019-04-03T16:42:23Z",
"executionDate": "2019-04-03T16:42:23Z",
"assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"note": "A dummy note",
"assignmentState": "ACCEPTED",
"state": "PLANNED"
}

Delete a soil sampling task

Authorizations:

OAuth2

path Parameters

uuid

required

string <uuid>

Example: 199067a9-5bb1-4f20-9641-a35d5ce31e19

Define resource by uuid

Responses

Growth Stages (V2)

A growth stage defines a certain stage in the development of a crop measured on a certain scale, e.g. when the plant starts flowering then the scale defines an index that represents 'flowering'.

Create growth stage predictions

This endpoint is used by the Horta service to post growth stage predictions.

Request Body schema: application/json

Array

index required	string
scale required	string Value: "BBCH"
cropSeasonUuid required	string <uuid>
provider required	string
startDate required	string <date-time>
endDate required	string <date-time>
calculationDate required	string <date-time>

Responses

Request samples

Payload

Content type

application/json

[{"index": "1",
"scale": "BBCH",
"cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"provider": "XARVIO",
"startDate": "2019-04-03T16:42:23Z",
"endDate": "2019-04-03T16:42:23Z",
"calculationDate": "2019-04-03T16:42:23Z"
}
]

Response samples

201
400

Content type

application/json

[{"isStale": false,
"isLocked": false,
"calculationDate": "2019-04-03T16:42:23Z",
"startDate": "2019-04-03T16:42:23Z",
"endDate": "2019-04-03T16:42:23Z",
"index": "05",
"scale": "BBCH",
"cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"gsOrder": 42,
"provider": "XARVIO"
}
]

Get growth stage predictions

Returns growth stage predictions based on given filter.
When filtering using fromDate and tillDate, both parameters must be passed.

Authorizations:

OAuth2

query Parameters

includeOverlappedGrowthStage	boolean Default: false Example: includeOverlappedGrowthStage=true return response with/without overlapping growthstages.
convertToScale	string Enum: "BBCH" "ISU" "ZADOKS" "VBFC" "HORTA_TRZDW_GS" "ISU_LENTIL" "ISU_PEA" "HORTA_GRAPE_NUTRITION" "HORTA_WHEAT_NUTRITION" Example: convertToScale=BBCH optional filter to get growthstage in this scale.
cropSeasonUuid required	Array of strings <uuid> Example: cropSeasonUuid=2a84e031-c5c6-4fcf-95f6-1341c5ebef80 Filter by cropseason uuid
fromDate	string <date-time> Example: fromDate=2021-04-03T12:34:56Z from date, inclusive. A calculation valid-range needs to intersect the range from fromDate(inclusive) and tillDate(exclusive) to match the filter.
tillDate	string <date-time> Example: tillDate=2021-04-03T12:34:56Z till date, exclusive. A calculation valid-range needs to intersect the range from fromDate(inclusive) and tillDate(exclusive) to match the filter.

Responses

Response samples

200
400
404

Content type

application/json

[{"isStale": false,
"isLocked": false,
"calculationDate": "2019-04-03T16:42:23Z",
"startDate": "2019-04-03T16:42:23Z",
"endDate": "2019-04-03T16:42:23Z",
"index": "05",
"scale": "BBCH",
"cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"gsOrder": 42,
"provider": "XARVIO"
}
]

Important Stages (V2)

Important growth stages are a subset of all possible growth stages and include those that are considered to be important for agronomic decisions. Other growth stages are typically not getting predicted by growth stage models.

Get important growth stages

This service is proxy to MD growth stage data. Filter should be Combination of growthStageUuid, cropUuid and countryCode OR cropUuid and countryCode.

Authorizations:

OAuth2

query Parameters

cropUuid	Array of strings <uuid> Example: cropUuid=9b4ee6b2-ae2d-6c9a-af77-08a4b749031f Filter by crop uuid
countryCode	string Example: countryCode=DE Filter by country code (`DE`, `FR`, `US`)
growthStageUuid	Array of strings <uuid> Example: growthStageUuid=199067a9-5bb1-4f20-9641-a35d5ce31e19 Filter by growth stage uuid master data.

Responses

Response samples

200
400

Content type

application/json

[{"uuid": "6c8a42be-1bc5-47a0-b671-251045e04a61",
"index": "05",
"scale": "BBCH",
"cropUuid": "9b4ee6b2-ae2d-6c9a-af77-08a4b749031f",
"gsOrder": 42,
"countryCode": "DE",
"isMilestone": true
}
]

Shop service

Shop service handles orders, vouchers and licenses.

Create a partner order

Prepare an order.

Authorizations:

OAuth2

Request Body schema: application/json

farmUuid required	string or null <uuid>
voucherCode required	string
required	object (Address) User address
vatId	string

Responses

Request samples

Payload

Content type

application/json

{"farmUuid": "m1dc4521-6797-4f57-8437-a539c5dea0f9",
"voucherCode": "VOUCHERSHOPX",
"customerAddress": {"firstName": "Donald",
"lastName": "Duck",
"company": "Disney",
"street": "str.4",
"provinceId": 13243,
"countryId": "de",
"city": "langenfeld",
"postCode": 40764,
"telephone": 1763457896,
"email": "jane.doe@xarvio.com"
},
"vatId": 12345
}

Response samples

201
400

Content type

application/json

{"uuid": "m1dc4521-6797-4f57-8437-a539c5dea0f9",
"farmUuid": "m1dc4521-6797-4f57-8437-a539c5dea0f9",
"voucherCode": "VOUCHERSHOPX",
"customerAddress": {"firstName": "Donald",
"lastName": "Duck",
"company": "Disney",
"street": "str.4",
"provinceId": 13243,
"countryId": "de",
"city": "langenfeld",
"postCode": 40764,
"telephone": 1763457896,
"email": "jane.doe@xarvio.com"
},
"vatId": 12345
}

Retrieve partner orders

Retrieve orders by farm.

Authorizations:

OAuth2

query Parameters

farmUuid

Array of strings <uuid>

Example: farmUuid=9b4ee6b2-ae2d-6c9a-af77-08a4b749031f

Filter by farm uuid

Responses

Response samples

200
400

Content type

application/json

[{"uuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"creatorId": "e7dac807da134b05b58933df9df5ef44",
"farmUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"orderDate": "2019-10-03T16:42:23Z"
}
]

Get single partner order

Authorizations:

OAuth2

path Parameters

uuid

required

string <uuid>

Example: 199067a9-5bb1-4f20-9641-a35d5ce31e19

Define resource by uuid

Responses

Response samples

200
400

Content type

application/json

{"uuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"creatorId": "e7dac807da134b05b58933df9df5ef44",
"farmUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"orderDate": "2019-10-03T16:42:23Z"
}

Request quote for selected products.

Request quote

Request Body schema: application/json

farmUuid	string or null
seller	string Default: "BASF_DIGITAL_FARMING" Enum: "BASF_DIGITAL_FARMING" "BOSCH_BASF_SMART_FARMING" Seller used to determine the magento webstore
voucherCode	string
withDynamicPricing	boolean Default: true Specifies, whether the quotes calculation should be performed for dynamic license duration period, evaluated based on validity of already assigned packages, or for default license duration of 365 days.
required	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"farmUuid": "m1dc4521-6797-4f57-8437-a539c5dea0f9",
"seller": "BASF_DIGITAL_FARMING",
"voucherCode": "VOUCHERSHOPX",
"withDynamicPricing": true,
"items": [{"uuid": "m1dc4521-6797-4f57-8437-a539c5dea0f9",
"quantity": 1.5
}
]
}

Response samples

200
400

Content type

application/json

{"baseTotal": 120,
"discountAmount": 20,
"payableAmount": 114,
"currencyCode": "EUR",
"voucherCode": "VOUCHERSHOPX",
"items": {"uuid": "m1dc4521-6797-4f57-8437-a539c5dea0f9",
"price": 120,
"discountAmount": 20,
"quantity": 1.5,
"baseTotal": 20
}
}

Crop

Crop defined by EPPO - https://gd.eppo.int/

Get available crops

Authorizations:

OAuth2

query Parameters

uuid	Array of strings <uuid> Example: uuid=199067a9-5bb1-4f20-9641-a35d5ce31e19 Filter by resource uuid
eppoCode	Array of strings Example: eppoCode=TRZDU Filter by EPPO code. Multiple codes can be requested using coma separator.
locale	string <string> Example: locale=DE-AT Filter by locale in iso2 code.
taxonomyCode	string <string> Example: taxonomyCode=SPECIE Filter by taxonomyCode.

Responses

Response samples

200
400

Content type

application/json

[{"uuid": "4e590bac-d28b-42f4-cd42-477a7a179097",
"eppoCode": "TRZDU",
"name": "Triticum durum",
"scientificName": "Glycine max",
"taxonomyCode": "SPECIE",
"taxonomyName": "Species"
}
]

Product

Either uuid ,code, registrationNumber or countryIso2Code filter is required.

Get available products

Authorizations:

OAuth2

query Parameters

uuid	Array of strings <uuid> Example: uuid=199067a9-5bb1-4f20-9641-a35d5ce31e19 Filter by resource uuid
code	Array of strings <homologa-code> Example: code=916245884 Filter by homologa code. Multiple codes can be requested using coma separator. Generally first 3 digits or letters are country code from homologa and then followed with product registration number.
registrationNumber	Array of strings <homologa-code> Example: registrationNumber=040498-60 Filter by homologa product registration number.Multiple registration numbers can be requested using coma separator.
countryIso2Code	Array of strings <iso2> Example: countryIso2Code=FR Filter by country ISO-2 code. Multiple codes can be requested using coma separator.
productCategories	Array of strings Example: productCategories=F_I_N Filter by product category code . Multiple codes can be requested using coma separator.
applictionDate	string <date-time> Example: applictionDate=2015-09-08T00:00:00.000Z Default is today in UTC. Filter by product expiry date or last commercial use date >= applicationDate.

Responses

Response samples

200
400

Content type

application/json

[{"uuid": "c5f14573-339c-53dd-d5f6-ccf311367245",
"code": "906040498-60",
"name": "Asulfa Jet",
"productCategories": [{"uuid": "b5f14573-339c-53dd-d5f6-ccf311367245",
"code": "F",
"name": "Fungicide"
}
],
"organizations": [{"uuid": "q5f14573-339c-53dd-d5f6-ccf311367245",
"code": "BAYER-CROPSCIENCE",
"name": "Bayer CropScience"
}
],
"registrationNumber": "040498-60",
"countryIso2Code": "DE"
}
]

Tillagesystem

Tillage is the agricultural preparation of soil by mechanical agitation of various types, such as digging, stirring, and overturning. This EP is dedicated to the external consumers.

Get available Tillage-systems

Authorizations:

OAuth2

query Parameters

uuid	Array of strings <uuid> Example: uuid=199067a9-5bb1-4f20-9641-a35d5ce31e19 Filter by resource uuid
code	Array of strings Filter by code. Multiple code can be requested using coma separator. Logical AND is applied in case both uuid and code filter.
locale	string <string> Example: locale=DE-AT Filter by locale in iso2 code.

Responses

Response samples

200
400

Content type

application/json

[{"uuid": "4e590bac-d28b-42f4-cd42-477a7a179097",
"code": "DIS",
"name": "Semis direct"
}
]

Variety

Either uuid, code, or countryIso2Code filter is required.

Get available varieties

Authorizations:

OAuth2

query Parameters

uuid	Array of strings <uuid> Example: uuid=199067a9-5bb1-4f20-9641-a35d5ce31e19 Filter by resource uuid
code	Array of strings Example: code=FR-TRZAW-GALACTIC Filter by code. Multiple codes can be requested using coma separator.
cropUuid	Array of strings <uuid> Example: cropUuid=9b4ee6b2-ae2d-6c9a-af77-08a4b749031f Crop uuids (/api/md2/partners/crops) can be requested using coma separator.
cropEppoCode	Array of strings Example: cropEppoCode=TRZAW Filter by EPPO code (/api/md2/partners/crops). Multiple codes can be requested using coma separator.
countryIso2Code	Array of strings <iso2> Example: countryIso2Code=FR Filter by country ISO-2 code. Multiple codes can be requested using coma separator.
locale	string <string> Example: locale=DE-AT Filter by locale in iso2 code.
companyUuid	string <uuid> Example: companyUuid=32c102ad-0cd5-3721-2119-4f13338974c7 Filter by company or breeder uuid.
companyCode	string <strng> Example: companyCode=BASF Filter by company or breeder code.
companyName	string <strng> Example: companyName=BASF Filter by company or breeder name. It's case insensitive and ensure best match for a given string.

Responses

Response samples

200
400

Content type

application/json

[{"uuid": "997a7532-38c2-ffc5-c8c5-9cb0af2e51f3",
"code": "FR-TRZAW-GALACTIC",
"name": "GALACTIC",
"cropUuid": "9b4ee6b2-ae2d-6c9a-af77-08a4b749031f",
"cropEppoCode": "TRZAW",
"breederName": "Secobra Recherches SAS",
"countryIso2Code": "DE",
"registrationNumber": "512C269"
}
]

Stress

Stress (weed or disease) defined by EPPO - https://gd.eppo.int/

Get available stresses

Authorizations:

OAuth2

query Parameters

uuid	Array of strings <uuid> Example: uuid=199067a9-5bb1-4f20-9641-a35d5ce31e19 Filter by resource uuid
eppoCode	Array of strings Example: eppoCode=TRZDU Filter by EPPO code. Multiple codes can be requested using coma separator.
locale	string <string> Example: locale=DE-AT Filter by locale in iso2 code.
taxonomyClassCode	Array of strings <string> Example: taxonomyClassCode=SPECIE Filter by taxonomyCode. Multiple codes can be requested using coma separator.
stressTypeCode	Array of strings <string> Example: stressTypeCode=MICORG Filter by stressTypeCode. Multiple codes can be requested using coma separator.

Responses

Response samples

200
400

Content type

application/json

[{"uuid": "ab9649ac-caa4-4b38-de7f-1d3724c548b8",
"eppoCode": "GLXMA",
"name": "Soja",
"scientificName": "Glycine max",
"taxonomyCode": "SPECIE",
"taxonomyName": "Species",
"stressTypeCode": "PLANT",
"stressTypeName": "Plant"
}
]

Action Recommendation Aggregation

An aggregation of all recommendations for a field

Get all aggregated action recommendations, for a crop season

Authorizations:

OAuth2

query Parameters

cropSeasonUuid required	Array of strings <uuid> Example: cropSeasonUuid=2a84e031-c5c6-4fcf-95f6-1341c5ebef80 Filter by cropseason uuid
actionStatus	Array of strings Items Enum: "ACTIVE" "SNOOZED" Example: actionStatus=ACTIVE Status of the actions to be returned.
actionType	Array of strings Items Enum: "FUNGICIDE_APPLICATION" "INSECTICIDE_APPLICATION" "PLANT_GROWTH_REGULATOR_APPLICATION" "FERTILIZER_APPLICATION" "WATER_MANAGEMENT" Example: actionType=FUNGICIDE_APPLICATION actionType

Responses

Response samples

200

Content type

application/json

[{"cropSeasonUuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"aggregatedStatus": "ACTIVE",
"actions": [{"type": "FUNGICIDE_APPLICATION",
"status": "ACTIVE",
"predictionStartDate": "2019-04-02T16:42:23Z",
"predictionEndDate": "2019-04-02T16:42:23Z",
"calculationDate": "2019-04-02T16:42:23Z"
}
]
}
]

Nutrition Status

This endpoint provides nutrition-status based on timing rules and executed sprayings filtered by cropseason.

Get nutrition status

This endpoint provides nutrition-status based on timing rules and executed sprayings filter by cropseason.
When filtering using fromDate and tillDate, both parameters must be passed.

Authorizations:

OAuth2

query Parameters

cropSeasonUuid required	string <uuid> Example: cropSeasonUuid=2a84e031-c5c6-4fcf-95f6-1341c5ebef80 Filter by cropseason uuid
fromDate	string <date-time> Example: fromDate=2019-04-03T16:42:23Z from date
tillDate	string <date-time> Example: tillDate=2019-04-03T16:42:23Z till date

Responses

Response samples

200
400

Content type

application/json

[{"calculationDate": "2019-04-03T16:42:23Z",
"status": "HIGH",
"cropSeasonUuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"startDate": "2019-04-03T16:42:23Z",
"endDate": "2019-04-03T16:42:23Z"
}
]

Nutrition Recommendation

This endpoint provides nutrition-recommendations calculated for each Application window. Application windows are determined by specific timing-rules for crop and country. Only current and future recommendations will be provided.

Get nutrition recommendation

This endpoint provides nutrition-recommendations based on filters

Authorizations:

OAuth2

query Parameters

cropSeasonUuid required	string <uuid> Example: cropSeasonUuid=2a84e031-c5c6-4fcf-95f6-1341c5ebef80 Filter by cropseason uuid
fromDate	string <date-time> Example: fromDate=2019-04-03T16:42:23Z from date
tillDate	string <date-time> Example: tillDate=2019-04-03T16:42:23Z till date

Responses

Response samples

200
400

Content type

application/json

[{"calculationDate": "2019-04-03T16:42:23Z",
"actionType": "FERTILIZER_APPLICATION",
"cropSeasonUuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"startDate": "2019-04-03T16:42:23Z",
"endDate": "2019-04-03T16:42:23Z",
"confidenceLevel": "OBSERVE_BEFORE_TREAT",
"status": "RECOMMENDED",
"description": "Keep the field with high moisture"
}
]

Water Status

This endpoint provides water-status for a cropseason based on Application windows and the current growthstage. Application windows are determined by specific timing-rules for crop and country. The returned list represent the status for today plus 4 days forecast.

Get water status

This endpoint provides water-status for a cropseason based on Application windows and the current growthstage.
When filtering using fromDate and tillDate, both parameters must be passed.

Authorizations:

OAuth2

query Parameters

cropSeasonUuid required	Array of strings <uuid> Example: cropSeasonUuid=2a84e031-c5c6-4fcf-95f6-1341c5ebef80 Filter by cropseason uuid
fromDate	string <date-time> Example: fromDate=2019-04-03T16:42:23Z from date
tillDate	string <date-time> Example: tillDate=2019-04-03T16:42:23Z till date

Responses

Response samples

200
400

Content type

application/json

[{"calculationDate": "2019-04-03T16:42:23Z",
"status": "HIGH",
"cropSeasonUuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"startDate": "2019-04-03T16:42:23Z",
"endDate": "2019-04-03T16:42:23Z"
}
]

Water Recommendation

This endpoint provides water-recommendations calculated for each Applicationwindow. Application windows are determined by specific timing-rules for crop and country. Only current and future recommendations will be provided.

Get water recommendation

This endpoint provides water-recommendations based on water-status filter by cropseason

Authorizations:

OAuth2

query Parameters

cropSeasonUuid required	Array of strings <uuid> Example: cropSeasonUuid=2a84e031-c5c6-4fcf-95f6-1341c5ebef80 Filter by cropseason uuid
fromDate	string <date-time> Example: fromDate=2019-04-03T16:42:23Z from date
tillDate	string <date-time> Example: tillDate=2019-04-03T16:42:23Z till date

Responses

Response samples

200
400

Content type

application/json

[{"calculationDate": "2019-04-03T16:42:23Z",
"actionType": "WATER_MANAGEMENT",
"cropSeasonUuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"startDate": "2019-04-03T16:42:23Z",
"endDate": "2019-04-03T16:42:23Z",
"confidenceLevel": "TREAT",
"status": "RECOMMENDED",
"description": "Keep the field with high moisture"
}
]

Field Entries

Field entries

Create field entry

Authorizations:

OAuth2

Request Body schema: application/json

fieldUuid required	string <uuid> Reference to the field the field entry belongs to
name	string or null [ 1 .. 65536 ] characters Name of the field entry
	object GeoJson point in epsg 4326 https://tools.ietf.org/html/rfc7946#section-3.1.2

Responses

Request samples

Payload

Content type

application/json

{"fieldUuid": "4dfc2bed-21f4-490e-acf1-d0cebafb7185",
"name": "#1",
"location": {"type": "Point",
"coordinates": [7.2263968,
53.5531078
]
}
}

Response samples

201
400

Content type

application/json

{"uuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"creatorId": "e7dac807da134b05b58933df9df5ef44",
"lastModifierId": "e7dac807da134b05b58933df9df5ef44",
"etag": "\"1\"",
"fieldUuid": "47553bd3-b41f-473a-9ec8-be94aefac1f7",
"name": "#1",
"location": {"type": "Point",
"coordinates": [7.2263968,
53.5531078
]
}
}

List field entries

get field entries. At least one parameter is required.

Authorizations:

OAuth2

query Parameters

uuid	Array of strings <uuid> Example: uuid=199067a9-5bb1-4f20-9641-a35d5ce31e19 Filter by resource uuid
fieldUuid	Array of strings <uuid> Example: fieldUuid=2a84e031-c5c6-4fcf-95f6-1341c5ebef80 Filter by field uuid

Responses

Response samples

200
400

Content type

application/json

[{"uuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"creatorId": "e7dac807da134b05b58933df9df5ef44",
"lastModifierId": "e7dac807da134b05b58933df9df5ef44",
"etag": "\"1\"",
"fieldUuid": "47553bd3-b41f-473a-9ec8-be94aefac1f7",
"name": "#1",
"location": {"type": "Point",
"coordinates": [7.2263968,
53.5531078
]
}
}
]

Get field entry

Authorizations:

OAuth2

path Parameters

uuid

required

string <uuid>

Example: 199067a9-5bb1-4f20-9641-a35d5ce31e19

Define resource by uuid

header Parameters

If-None-Match

string

Example: "1"

ETag of the resource to fetch. If the resource is unchanged on the server it will respond with 304 Not Modified

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag

Responses

Response samples

200
400

Content type

application/json

{"uuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"creatorId": "e7dac807da134b05b58933df9df5ef44",
"lastModifierId": "e7dac807da134b05b58933df9df5ef44",
"etag": "\"1\"",
"fieldUuid": "47553bd3-b41f-473a-9ec8-be94aefac1f7",
"name": "#1",
"location": {"type": "Point",
"coordinates": [7.2263968,
53.5531078
]
}
}

Delete field entry

Authorizations:

OAuth2

path Parameters

uuid

required

string <uuid>

Example: 199067a9-5bb1-4f20-9641-a35d5ce31e19

Define resource by uuid

Responses

Update field entry

Authorizations:

OAuth2

path Parameters

uuid

required

string <uuid>

Example: 199067a9-5bb1-4f20-9641-a35d5ce31e19

Define resource by uuid

header Parameters

If-Match

required

string

Example: "1"

ETag of the resource to update.

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag

Request Body schema: application/merge-patch+json

name	string or null [ 1 .. 65536 ] characters Name of the field entry
	object GeoJson point in epsg 4326 https://tools.ietf.org/html/rfc7946#section-3.1.2

Responses

Request samples

Payload

Content type

application/merge-patch+json

{"name": "#1",
"location": {"type": "Point",
"coordinates": [7.2263968,
53.5531078
]
}
}

Response samples

200
400
412
428

Content type

application/json

{"uuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"creatorId": "e7dac807da134b05b58933df9df5ef44",
"lastModifierId": "e7dac807da134b05b58933df9df5ef44",
"etag": "\"1\"",
"fieldUuid": "47553bd3-b41f-473a-9ec8-be94aefac1f7",
"name": "#1",
"location": {"type": "Point",
"coordinates": [7.2263968,
53.5531078
]
}
}

Crop Season Status Reports

Customizable crop season status reports that include important status of a crop season (e.g. diseases)

Create customized crop season status report

Authorizations:

OAuth2

Request Body schema: application/json

locale required	string^[A-Z]{2}_[A-Z]{2}$ locale in format LANGUAGE_COUNTRY
cropSeasonUuids required	Array of strings <uuid>
theme	string or null theme defaults to XARVIO.
	object

Responses

Request samples

Payload

Content type

application/json

{"locale": "EN_GB",
"cropSeasonUuids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"theme": "XARVIO",
"sections": {"diseases": {"summary": false,
"details": false
},
"insects": {"summary": false,
"details": false
},
"abiotics": {"summary": false,
"details": false
},
"lodgings": {"summary": false,
"details": false
},
"growthstages": {"summary": false,
"details": false
}
}
}

Response samples

200
400

Content type

application/json

{"uuid": "8f0fd948-6c02-41de-a017-e7d8fca46956",
"pdfUrl": "http://example.com",
"locale": "EN_GB",
"cropSeasonUuids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"theme": "XARVIO",
"sections": {"diseases": {"summary": false,
"details": false
},
"insects": {"summary": false,
"details": false
},
"abiotics": {"summary": false,
"details": false
},
"lodgings": {"summary": false,
"details": false
},
"growthstages": {"summary": false,
"details": false
}
}
}

Download customized crop season status report

Authorizations:

OAuth2

path Parameters

uuid

required

string <uuid>

Example: 199067a9-5bb1-4f20-9641-a35d5ce31e19

Define resource by uuid

Responses

Response samples

400

Content type

application/json

{"statusCode": 400,
"messages": ["string"
],
"timestamp": 0,
"traceId": "string",
"errorCode": "string"
}

Soil samplings

Soil sampling is the process of extracting a small volume of soil for subsequent analysis at a lab. The results obtained will include its nutrient content, composition and other characteristics that are important to plant health.

Get a soil sampling task by uuid

Authorizations:

OAuth2

path Parameters

uuid

required

string <uuid>

Example: 199067a9-5bb1-4f20-9641-a35d5ce31e19

Define resource by uuid

header Parameters

If-None-Match

string

Example: "1"

ETag of the resource to fetch. If the resource is unchanged on the server it will respond with 304 Not Modified

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag

Responses

Response samples

200
400

Content type

application/json

{"uuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"creatorId": "e7dac807da134b05b58933df9df5ef44",
"lastModifierId": "e7dac807da134b05b58933df9df5ef44",
"etag": "\"1\"",
"cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"soilSamplingSetUuid": "3a84e031-c5c6-4fcf-95f6-1341c5ebef80",
"sampledPoints": [{"geometry": {"type": "Point",
"coordinates": [7.2263968,
53.5531078
]
}
}
],
"plannedDate": "2019-04-03T16:42:23Z",
"executionDate": "2019-04-03T16:42:23Z",
"assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
"note": "A dummy note",
"assignmentState": "ACCEPTED",
"state": "PLANNED"
}

Residual Activation

Provides status information regarding the activation of selected residual herbicides.

Residual activations

Returns the residual activation status for a sprayingUuid

Authorizations:

OAuth2

query Parameters

sprayingUuid

required

Array of strings <uuid>

Example: sprayingUuid=199067a9-5bb1-4f20-9641-a35d5ce31e19

Filter by sprayingUuid

Responses

Response samples

200
400

Content type

application/json

[{"isStale": false,
"isLocked": false,
"calculationDate": "2019-04-03T07:42:23Z",
"sprayingUuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"activationDeadline": "2022-03-27T23:59:59Z",
"activationDate": "2022-03-27T23:59:59Z",
"scoutingReminderDate": "2022-03-27T23:59:59Z",
"status": "SUCCESSFUL"
}
]

Residual Activation Recommendations

Provides recommendations for optimal application of residual herbicides.

Residual activation recommendations

Returns recommendations for optimal activation of residual herbicides (Outlook, Zidua SC and Zidua Pro) for specified crop season

Authorizations:

OAuth2

query Parameters

cropSeasonUuid

required

Array of strings <uuid>

Example: cropSeasonUuid=2a84e031-c5c6-4fcf-95f6-1341c5ebef80

Filter by cropseason uuid

Responses

Response samples

200
400

Content type

application/json

[{"isStale": false,
"isLocked": false,
"calculationDate": "2019-04-03T07:42:23Z",
"startDate": "2019-04-03T00:00:00Z",
"endDate": "2019-04-04T00:00:00Z",
"cropSeasonUuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"productUuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
"probabilityOfExceedencePct": 100
}
]