xarvio Field Manager logo
Documentation Powered by ReDoc

xarvio Field Manager Public API (0.1.153)

Download OpenAPI specification:Download

E-mail: support@xarvio.com

Authentication

OAuth2

Security Scheme Type OAuth2
authorizationCode OAuth Flow
Authorization URL: https://auth.xarvio.com/auth/auth
Token URL: https://auth.xarvio.com/auth/token
Scopes:
  • farm -

    Create, modify and update farms. Contains scope read:farm

  • read:farm -

    Read farms

  • field -

    Create, modify and update fields. Contains scope read:field

  • read:field -

    Read fields

  • cropseason -

    Create, modify and update cropseaons. Contains scope read:cropseaon

  • read:cropseason -

    Read cropseaons

  • read:aggregatedrisk -

    Read aggregated risk

  • read:risk -

    Read risk

  • read:applicationrecommendation -

    Read Application Recommendations

  • read:actionrecommendation -

    Read Action Recommendations

  • read:nutritionrecommendation -

    Read Nutrition Recommendations

  • read:waterrecommendation -

    Read Water Recommendation

  • read:nutritionstatus -

    Read Nutrition Status

  • read:waterstatus -

    Read Water Status

  • read:sprayingwindow -

    Read spraying windows

  • read:actionwindow -

    Read action windows

  • read:protectiontime -

    Read protection times

  • read:limitation -

    Read limitation

  • read:stressquestion -

    Read stress questions

  • read:stressanswer -

    Read stress answers

  • read:timingstress -

    Read stresses

  • recommendedrecipe -

    Read recommended receipes

  • read:cropseasonstatus -

    Read crop season status

  • read:dailyweedriskdetails -

    Read daily weed risk details

  • read:productrecommendation -

    Read product recommendations

  • productrecommendationsgroups -

    Get product recommendations groups

  • dosedmap -

    Create, modify and update dosed maps. Contains scope read:dosedmap

  • read:dosedmap -

    Read dosed maps

  • sourcemap -

    Create, modify and update source maps. Contains scope read:sourcemap

  • read:sourcemap -

    Read source maps

  • spraying -

    Create, modify and update sprayings. Contains scope read:spraying

  • read:spraying -

    Read sprayings

  • observation -

    Create, modify and update observations. Contains scope read:observation

  • read:observation -

    Read observations

  • read:growthstage -

    Read growth stages

  • read:growthstageprediction -

    Read growth stage predictions

  • droneflight -

    Create, modify and update drone flight task. Contains scope read:droneflight

  • read:droneflight -

    Read drone flight tasks

  • fielddatalayer -

    Create, modify and update field data. Contains scope read:fielddatalayer

  • read:fielddatalayer -

    Read field data

  • herbiciderecommendation -

    Create, modify and update herbicide recommendation data. Contains scope read:herbiciderecommendation

  • read:herbiciderecommendation -

    Read herbicide recommendation data

  • user -

    Create, modify and update users. Contains scope read:user

  • read:user -

    Read users

  • delete:user -

    Delete users

  • notification -

    Create, modify and update notifications. Contains scope read:notification

  • read:notification -

    Read notifications

  • order -

    Create, modify and update orders. Contains scope read:order

  • read:order -

    Read orders

  • read:license -

    Read licenses

  • read:voucher -

    Read vouchers

  • read:satimagearchive -

    Read zoner service

  • read:weedrisk -

    Read weed risk service

  • johndeere -

    Create, modify and update john deere data. Contains scope read:johndeere

  • read:johndeere -

    Read john deere data

  • dke-agrirouter -

    Create, modify and update DKE Agrirouter data. Contains scope read:dke-agrirouter

  • read:dke-agrirouter -

    Read DKE Agrirouter data

  • kwsanalysis -

    Create, modify and update KWS Analysis data. Contains scope read:kwsanalysis

  • read:kwsanalysis -

    Read KWS Analysis data

  • hfservicerequest -

    Create, modify and update Healthy Fields service requests. Contains scope read:hfservicerequest

  • read:hfservicerequest -

    Read Healthy fields service requests

  • email -

    Create customer communication invitation. Contains scope read:email

  • read:email -

    Read customer communication invitation list

  • applicationmapdownload -

    Create and update application maps download. Contains scope read:applicationmapdownload

  • read:applicationmapdownload -

    Read application maps downloads

  • read:actionrecommendationaggregation -

    Read action recommendation aggregations

  • read:biomassanalysis -

    Read biomass analysis

  • read:multiimagebiomassanalysis -

    Read multi-image biomass analysis

  • read:soilsamplingpowerzoneanalysis -

    Read soil sampling power analysis

  • read:weedclassificationndvi -

    Read weed classification NDVI

  • read:biomassanalysisndvi -

    Read biomass analysis NDVI

  • read:biomassmonitoringvectoranalysis -

    Read biomass monitoring vector analysis

  • read:custompowerzone -

    Read custom powerzone analysis

  • custompowerzone -

    Create custom powerzones. Contains scope read:custompowerzone

  • cropseasonstatusreport -

    Generate Crop Season Status Reports

  • read:cropseasonstatusreport -

    Download generated Crop Season Status Reports

  • read:partnertillage -

    Read tillage data for partner users

  • read:partnercrop -

    Read crop data for partner users

  • read:partnervariety -

    Read variety data for partner users

  • read:partnerproduct -

    Read product data for partner users

  • read:partnerstress -

    Read stress data for partner users

  • fieldentry -

    Create, modify and update field entry. Contains scope read:fieldentry

  • read:fieldentry -

    Read field entry

  • treatmentscenario -

    Create, modify and update treatment scenario. Contains scope read:treatmentscenario

  • read:treatmentscenario -

    Read treatment scenario.

  • cropseasontreatmentprogram -

    Create, modify and update crop season treatment program. Contains scope read:cropseasontreatmentprogram

  • read:cropseasontreatmentprogram -

    Read crop season treatment program

  • read:cropseasontreatmentprogramexecutionstatus -

    Read cropseason treatment program execution status

  • read:weedmanagementrecommendation -

    Read weedmanagement recommendation

  • watermanagementtask -

    Create, modify and update water management task. Contains scope read:watermanagementtask

  • read:watermanagementtask -

    Read water management task

  • landpreparation -

    Create, modify and update land preparation task. Contains scope read:landpreparation

  • read:landpreparation -

    Read land preparation task

  • cropresiduemanagementtask -

    Create, modify and update crop residue management task. Contains scope read:cropresiduemanagementtask

  • read:cropresiduemanagementtask -

    Read crop residue management task

  • harvest -

    Create, modify and update harvest task. Contains scope read:harvest

  • read:harvest -

    Read harvest task

  • producedeliverytask -

    Create, modify and update produce delivery task. Contains scope read:producedeliverytask

  • read:producedeliverytask -

    Read produce delivery task

  • fieldzone -

    Create, modify and update field zones. Contains scope read:fieldzone

  • read:fieldzone -

    Read field zone

  • onesoil-mdl-read-all -

    Read all entities from onesoil-mdl service

  • onesoilapplicationmapdispatchorder -

    Create, modify and update OneSoil application map dispatch order. Contains scope read:onesoilapplicationmapdispatchorder

  • read:onesoilapplicationmapdispatchorder -

    Read OneSoil application map dispatch order

  • onesoilreceivedfile -

    Create, modify and update OneSoil received files. Contains scope read:onesoilreceivedfile

  • read:onesoilreceivedfile -

    Read OneSoil received files

  • osmdldevice -

    Create, modify and update OneSoil user devices. Contains scope read:osmdldevice

  • read:osmdldevice -

    Read OneSoil user devices

  • exatrekdevice -

    Create, modify and update Exatrek user devices. Contains scope read:exatrekdevice

  • read:exatrekdevice -

    Read Exatrek user devices

  • exatrekmachine -

    Create, modify and update Exatrek user machines. Contains scope read:exatrekmachine

  • read:exatrekmachine -

    Read Exatrek user machines

  • wiuz -

    Create, modify and update wiuz data. Contains scope read:wiuz

  • read:wiuz -

    Read wiuz data

  • admin:geoserverpublishraster -

    Create, modify and update rasters in geoserver.

  • seedtreatment -

    Create, modify and update seed treatment task. Contains scope read:seedtreatment

  • read:seedtreatment -

    Read seed treatment task

  • seedboxtreatment -

    Create, modify and update seed box treatment task. Contains scope read:seedboxtreatment

  • read:seedboxtreatment -

    Read seed box treatment task

  • file -

    Create, modify and update files

  • read:file -

    Read files

  • admin:file -

    Create, modify and update files

  • hfoffer -

    Create, modify and update hfoffer

  • read:hfoffer -

    Read hfoffer

  • HF_MGMT -

    Healthy Fields Admin

  • read:residualactivation -

    Read residual activations and residual activation recommendations

  • PACKAGE_MGMT -

    Package Management Admin

  • OS_MDL_ADMIN -

    OS MDL Admin

  • DEVICE_MGMT -

    Device Management Admin

  • hfreferencecode -

    Create, modify and update hf reference code. Contains scope read:seedboxtreatment

  • read:hfreferencecode -

    Read hf reference code

  • HF_DISTRIBUTOR -

    Healthy Fields Distributor

  • HF_TECH_ONBOARDING -

    Healthy Fields Technical Onboarder

  • cropseasonnutritionprogram -

    Create, modify and update crop season nutrition program. Contains scope read:cropseasonnutritionprogram

  • read:cropseasonnutritionprogram -

    Read crop season nutrition program

  • cropseasonnutritionrecommendation -

    Fetch crop season nutrition recommendation from a provider

  • crossfarmdashboard -

    Execute requests in Cross-Farm dashboard service against OpenSearch 'crossfarm-dashboard' index

  • crosshfdashboard -

    Execute requests in Cross-Farm dashboard service against OpenSearch 'cross-hf-service-request-dashboard' index

  • read:partnerorder -

    Fetch an partner order details

  • partnerorder -

    Create and fetch partner order. Contains scope read:partnerorder

  • weatheruserdata -

    Create, fetch and delete rainfall corrections for specific field location

  • soilsampling -

    Create, modify and update soil samplings. Contains scope read:soilsampling

  • read:soilsampling -

    Read soil samplings

  • read:fieldvariability -

    Read field variability index

  • exatrekapplicationmapdispatchorder -

    Create, modify and update Exatrek application map dispatch order. Contains scope read:exatrekapplicationmapdispatchorder

  • read:exatrekapplicationmapdispatchorder -

    Read Exatrek application map dispatch order

  • CARBON_ADMIN -

    Carbon Admin

  • freshbiomassorder -

    Create, modify and update fresh biomass orders. Contains scope read:freshbiomassorder

  • read:freshbiomassorder -

    Read fresh biomass orders

  • read:freshbiomass -

    Read fresh biomass

  • protocol -

    Create, modify and update protocol. Contains scope read:protocol

  • read:protocol -

    Read protocol

  • trial -

    Create, modify and update trial. Contains scope read:trial

  • read:trial -

    Read trial

  • assessment -

    Create, modify and update assessment. Contains scope read:assessment

  • read:assessment -

    Read assessment

  • assessmentattachment -

    Create, modify and update assessment attachment. Contains scope read:assessmentattachment

  • read:assessmentattachment -

    Read assessment attachment

  • assessmentdata -

    Create, modify and update assessment data. Contains scope read:assessmentdata

  • read:assessmentdata -

    Read assessment data

  • assessmenttiming -

    Create, modify and update assessment timing. Contains scope read:assessmenttiming

  • read:assessmenttiming -

    Read assessment timing

  • protocolattachment -

    Create, modify and update protocol attachment. Contains scope read:protocolattachment

  • read:protocolattachement -

    Read protocol attachment

  • read:smartsprayer -

    Read smart sprayer information

  • smartsprayingexecution -

    Create, modify and update smart sprayer execution. Contains scope read:smartsprayerexecution

  • read:smartsprayingexecution -

    Read smart sprayer execution

  • smartsprayerregistration -

    Create, modify and update smart sprayer registration. Contains scope read:smartsprayerregistration

  • read:smartsprayerregistration -

    Read smart sprayer registration

  • read:offlinethreshold -

    Read offline thresholds for smart sprayer

  • taskaggregation -

    Create and modify task aggregations. Contains scope read:taskaggregation

  • read:taskaggregation -

    Read task aggregations

  • read:task -

    Read general task information

  • ORGANISATION_MGMT -

    Organisation admin.

Farm

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

Create a farm

Authorizations:
OAuth2 (farm)
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
string or null
Enum: "ORCHARD" "VINEYARD"

Specialised usage type of the farm

Responses

Request samples

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:23.000Z",
  • "billingAddress": {
    },
  • "shippingAddress": {
    },
  • "growerUuid": "4dfc2bed-21f4-490e-acf1-d0cebafb7185",
  • "specialisedUsageType": "ORCHARD"
}

Response samples

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:23.000Z",
  • "billingAddress": {
    },
  • "shippingAddress": {
    },
  • "growerUuid": "4dfc2bed-21f4-490e-acf1-d0cebafb7185",
  • "specialisedUsageType": "ORCHARD",
  • "isCombinedUsageType": true,
  • "countrySubDivision": "DE-NW"
}

Retrieve all accessible farms

Authorizations:
OAuth2 (read:farm)
query Parameters
uuid
Array of strings <uuid>
Example: uuid=199067a9-5bb1-4f20-9641-a35d5ce31e19

Filter by resource uuid

lastUpdatedFrom
string <date-time>
Example: lastUpdatedFrom=

Optional. Filter by farms lastUpdated property, only farms which were updated after or at the given timestamp will be returned

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get single farm

Authorizations:
OAuth2 (read:farm)
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

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:23.000Z",
  • "billingAddress": {
    },
  • "shippingAddress": {
    },
  • "growerUuid": "4dfc2bed-21f4-490e-acf1-d0cebafb7185",
  • "specialisedUsageType": "ORCHARD",
  • "isCombinedUsageType": true,
  • "countrySubDivision": "DE-NW"
}

Update a farm

Authorizations:
OAuth2 (farm)
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

specialisedUsageType
string or null
Enum: "ORCHARD" "VINEYARD"

Specialised usage type of the farm

Responses

Request samples

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:23.000Z",
  • "billingAddress": {
    },
  • "shippingAddress": {
    },
  • "growerUuid": "4dfc2bed-21f4-490e-acf1-d0cebafb7185",
  • "specialisedUsageType": "ORCHARD"
}

Response samples

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:23.000Z",
  • "billingAddress": {
    },
  • "shippingAddress": {
    },
  • "growerUuid": "4dfc2bed-21f4-490e-acf1-d0cebafb7185",
  • "specialisedUsageType": "ORCHARD",
  • "isCombinedUsageType": true,
  • "countrySubDivision": "DE-NW"
}

Delete a farm

Authorizations:
OAuth2 (farm)
path Parameters
uuid
required
string <uuid>
Example: 199067a9-5bb1-4f20-9641-a35d5ce31e19

Define resource by uuid

Responses

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "statusCode": 400,
  • "messages": [
    ],
  • "timestamp": 0,
  • "traceId": "string"
}

Retrieves all accessible farms with pagination

Retrieves farms for the specified filter with pagination support.

Authorizations:
OAuth2 (read:farm)
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=

Optional. Filter by farms lastUpdated property, only farms which were updated after or at the given timestamp will be returned

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "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 (field)
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

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.

Responses

Request samples

Content type
application/json
{
  • "farmUuid": "string",
  • "name": "Test farm",
  • "boundary": {
    },
  • "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:23.000Z",
  • "tags": [
    ],
  • "centerLatitude": 45.123456,
  • "centerLongitude": 23.123456,
  • "soilOrganicMatterPercentage": 85.2,
  • "isInRedZone": true,
  • "schlagnummer": "123456789",
  • "flik": "123456789"
}

Response samples

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": {
    },
  • "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:23.000Z",
  • "tags": [
    ],
  • "centerLatitude": 45.123456,
  • "centerLongitude": 23.123456,
  • "soilOrganicMatterPercentage": 85.2,
  • "isInRedZone": true,
  • "schlagnummer": "123456789",
  • "flik": "123456789"
}

Read accessible fields

Either uuid or farmUuid filter is required.

Authorizations:
OAuth2 (read:field)
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=

Optional. Filter by fields lastUpdated property, only fields which were updated after or at the given timestamp will be returned

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get single field

Authorizations:
OAuth2 (read:field)
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

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": {
    },
  • "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:23.000Z",
  • "tags": [
    ],
  • "centerLatitude": 45.123456,
  • "centerLongitude": 23.123456,
  • "soilOrganicMatterPercentage": 85.2,
  • "isInRedZone": true,
  • "schlagnummer": "123456789",
  • "flik": "123456789"
}

Update a field

Authorizations:
OAuth2 (field)
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

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.

Responses

Request samples

Content type
application/merge-patch+json
{
  • "name": "Test farm",
  • "boundary": {
    },
  • "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:23.000Z",
  • "tags": [
    ],
  • "centerLatitude": 45.123456,
  • "centerLongitude": 23.123456,
  • "soilOrganicMatterPercentage": 85.2,
  • "isInRedZone": true,
  • "schlagnummer": "123456789",
  • "flik": "123456789"
}

Response samples

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": {
    },
  • "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:23.000Z",
  • "tags": [
    ],
  • "centerLatitude": 45.123456,
  • "centerLongitude": 23.123456,
  • "soilOrganicMatterPercentage": 85.2,
  • "isInRedZone": true,
  • "schlagnummer": "123456789",
  • "flik": "123456789"
}

Delete a field

Authorizations:
OAuth2 (field)
path Parameters
uuid
required
string <uuid>
Example: 199067a9-5bb1-4f20-9641-a35d5ce31e19

Define resource by uuid

Responses

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "statusCode": 400,
  • "messages": [
    ],
  • "timestamp": 0,
  • "traceId": "string"
}

Get single field boundary Deprecated

DEPRECATED: Use getFieldBoundariesByUuid with a single UUID instead.

Authorizations:
OAuth2 (read:field)
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"

Define export format of the boundary.

Responses

Response samples

Content type
application/json
{
  • "statusCode": 400,
  • "messages": [
    ],
  • "timestamp": 0,
  • "traceId": "string",
  • "errorCode": "string"
}

Get field boundaries

Authorizations:
OAuth2 (read:field)
query Parameters
format
string or null
Default: "kml"
Enum: "shp" "kml" "svg"

Define export format of the boundary.

fieldUuid
Array of strings <uuid> <= 1100 items
Example: fieldUuid=73750122-2d91-4554-a28f-db7ebee71c6e

Provide fieldUuids to export the boundaries for.

Responses

Response samples

Content type
application/json
{
  • "statusCode": 400,
  • "messages": [
    ],
  • "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 (cropseason)
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"

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

Responses

Request samples

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:23.000Z",
  • "endDate": "2019-04-03T16:42:23.000Z",
  • "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
}

Response samples

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:23.000Z",
  • "endDate": "2019-04-03T16:42:23.000Z",
  • "yieldExpectation": 48,
  • "yield": 14,
  • "boundary": {
    },
  • "boundaryChecksum": "48caffab77a67f0f9c485d330ce34a85462a50a2517e9ab0b5e3272d7b9d6355",
  • "cropEstablishmentMethodCode": "TRANSPLANTING",
  • "cropEstablishmentGrowthStageIndex": "05",
  • "cropEstablishmentGrowthStageScaleCode": "BBCH",
  • "isHealthyField": true,
  • "validityScore": 60.02,
  • "seedTreatmentUuid": "4dfc2bed-21f4-490e-acf1-d0cebafb7185",
  • "rowWidth": 0.7,
  • "cropMix": {
    },
  • "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
}

Read accessible crop-seasons

Either uuid or fieldUuid filter is required.

Authorizations:
OAuth2 (read:cropseason)
query Parameters
uuid
Array of strings <uuid>
Example: uuid=199067a9-5bb1-4f20-9641-a35d5ce31e19

Filter by resource uuid

fromDate
string <date-time>
Example:

Filter startDate to be greater then the fromDate

lifecycleState
Array of strings
Items Enum: "PLANNED" "ACTIVE" "CLOSED"

Filter cropseason by lifecycleState.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get single crop-season

Authorizations:
OAuth2 (read:cropseason)
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

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:23.000Z",
  • "endDate": "2019-04-03T16:42:23.000Z",
  • "yieldExpectation": 48,
  • "yield": 14,
  • "boundary": {
    },
  • "boundaryChecksum": "48caffab77a67f0f9c485d330ce34a85462a50a2517e9ab0b5e3272d7b9d6355",
  • "cropEstablishmentMethodCode": "TRANSPLANTING",
  • "cropEstablishmentGrowthStageIndex": "05",
  • "cropEstablishmentGrowthStageScaleCode": "BBCH",
  • "isHealthyField": true,
  • "validityScore": 60.02,
  • "seedTreatmentUuid": "4dfc2bed-21f4-490e-acf1-d0cebafb7185",
  • "rowWidth": 0.7,
  • "cropMix": {
    },
  • "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
}

Update a crop-season

Authorizations:
OAuth2 (cropseason)
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"

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

Responses

Request samples

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:23.000Z",
  • "endDate": "2019-04-03T16:42:23.000Z",
  • "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
}

Response samples

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:23.000Z",
  • "endDate": "2019-04-03T16:42:23.000Z",
  • "yieldExpectation": 48,
  • "yield": 14,
  • "boundary": {
    },
  • "boundaryChecksum": "48caffab77a67f0f9c485d330ce34a85462a50a2517e9ab0b5e3272d7b9d6355",
  • "cropEstablishmentMethodCode": "TRANSPLANTING",
  • "cropEstablishmentGrowthStageIndex": "05",
  • "cropEstablishmentGrowthStageScaleCode": "BBCH",
  • "isHealthyField": true,
  • "validityScore": 60.02,
  • "seedTreatmentUuid": "4dfc2bed-21f4-490e-acf1-d0cebafb7185",
  • "rowWidth": 0.7,
  • "cropMix": {
    },
  • "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
}

Delete a crop-season

Authorizations:
OAuth2 (cropseason)
path Parameters
uuid
required
string <uuid>
Example: 199067a9-5bb1-4f20-9641-a35d5ce31e19

Define resource by uuid

Responses

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "statusCode": 400,
  • "messages": [
    ],
  • "timestamp": 0,
  • "traceId": "string"
}

Get crop-season boundary

Authorizations:
OAuth2 (read:cropseason)
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"

Define export format of the boundary.

Responses

Response samples

Content type
application/json
{
  • "statusCode": 400,
  • "messages": [
    ],
  • "timestamp": 0,
  • "traceId": "string",
  • "errorCode": "string"
}

Users

Handle user activities.

Delete a user

Authorizations:
OAuth2 (delete:user)
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 (read:risk)
query Parameters
cropSeasonUuid
required
Array of strings <uuid>
Example: cropSeasonUuid=2a84e031-c5c6-4fcf-95f6-1341c5ebef80

Filter by cropseason uuid

fromDate
string <date-time>
Example:

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:

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"
Example: type=STRESS_RISK, STRESS_PRIMARY_RISK

type

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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 (read:actionrecommendation)
query Parameters
cropSeasonUuid
required
Array of strings <uuid>
Example: cropSeasonUuid=2a84e031-c5c6-4fcf-95f6-1341c5ebef80

Filter by cropseason uuid

fromDate
string <date-time>
Example:

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:

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

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Spraying Windows

Read current spraying window information for a crop season

Get current spraying window information for a crop season Deprecated

Authorizations:
OAuth2 (read:sprayingwindow)
query Parameters
cropSeasonUuid
required
Array of strings <uuid>
Example: cropSeasonUuid=2a84e031-c5c6-4fcf-95f6-1341c5ebef80

Filter by cropseason uuid

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Crop Season Status

Represents the status of a cropseason

Get crop season status

Recipe on how to get crop season status
Authorizations:
OAuth2 (read:cropseasonstatus)
query Parameters
cropSeasonUuid
required
Array of strings <uuid>
Example: cropSeasonUuid=2a84e031-c5c6-4fcf-95f6-1341c5ebef80

Filter by cropseason uuid

fromDate
string <date-time>
Example:

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:

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

Content type
application/json
[
  • {
    }
]

Daily weed risk details

Read daily weed risk details for a crop season

Get daily weed risk details

Authorizations:
OAuth2 (read:dailyweedriskdetails)
query Parameters
cropSeasonUuid
required
Array of strings <uuid>
Example: cropSeasonUuid=2a84e031-c5c6-4fcf-95f6-1341c5ebef80

Filter by cropseason uuid

fromDate
string <date-time>
Example:

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:

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

Content type
application/json
[
  • {
    }
]

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 (read:dosedmap)
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

Content type
application/json
[
  • {
    }
]

Create a dosed map

Authorizations:
OAuth2 (dosedmap)
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. Always 'NUTRITION_MANAGEMENT' for average-based-vra-dosed-maps.

fieldDataLayerUuid
string <uuid>

Required for Nutrition VRA Advisor. Referenced FDL contains required source map geometry.

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
Value: "LAI"

Required for Nutrition VRA Advisor. Currently supports only LAI index from the AgronomicIndexType enum.

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"

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 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
    • CUSTOM_POWERZONE_LAI
    • PLANET_LAI
    • BIOMASS_NDVI
    • SOIL
    • CUSTOM
    • VRA_ADVISOR
  • CUSTOM_VRA:
    • BIOMASS_LAI
    • SOIL_SAMPLING_POWERZONE
    • BIOMASS_MONITORING_VECTOR_ANALYSIS
    • CUSTOM_POWERZONE_LAI
    • PLANET_LAI
    • BIOMASS_NDVI
    • SOIL
    • CUSTOM
    • VRA_ADVISOR
  • Plus, for VRA and CUSTOM_VRA:
    • `DRONE_SYNTHETIC
    • DRONE_VARIGREEN
    • 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 ApplicationTypes 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.

Responses

Request samples

Content type
application/json
Example
FLAT
FLAT
VRA
VARIABLE_RATE_SEEDING
SPOT
{
  • "cropSeasonUuid": "4eb7eb0f-c0a7-4df7-8c51-1e38556ab704",
  • "productPackUuids": [
    ],
  • "recommendationDate": "2021-01-17T23:00:00.000Z",
  • "isHighFlow": false,
  • "applicationType": "FLAT",
  • "waterRates": [
    ],
  • "rates": [
    ],
  • "creationFlowHint": "CROP_PROTECTION",
  • "applicationDepth": 6.7,
  • "ureaseInhibitorUsed": true,
  • "nitrificationInhibitorUsed": true
}

Response samples

Content type
application/json
Example
FLAT
FLAT
VRA
VARIABLE_RATE_SEEDING
{
  • "uuid": "d58fb01e-06f2-40dc-b861-faa60fc19c80",
  • "cropSeasonUuid": "4eb7eb0f-c0a7-4df7-8c51-1e38556ab704",
  • "productPackUuids": [
    ],
  • "sourceMapUuid": "a28bc4e5-9b63-4cef-a957-d9fedf430eff",
  • "applicationType": "FLAT",
  • "applicationMode": "SPRAYING",
  • "actionTypes": [
    ],
  • "waterRates": [
    ],
  • "rates": [
    ],
  • "rxValues": [
    ],
  • "waterAverageApplicationRate": 0.0000198,
  • "waterTotalApplication": 1.2212892,
  • "applicationZones": [
    ],
  • "fieldZones": null,
  • "dateCreated": "2021-01-18T15:55:01.560Z",
  • "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": [
    ],
  • "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 (read:dosedmap)
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

Content type
application/json
Example
FLAT
FLAT
VRA
VARIABLE_RATE_SEEDING
{
  • "uuid": "d58fb01e-06f2-40dc-b861-faa60fc19c80",
  • "cropSeasonUuid": "4eb7eb0f-c0a7-4df7-8c51-1e38556ab704",
  • "productPackUuids": [
    ],
  • "sourceMapUuid": "a28bc4e5-9b63-4cef-a957-d9fedf430eff",
  • "applicationType": "FLAT",
  • "applicationMode": "SPRAYING",
  • "actionTypes": [
    ],
  • "waterRates": [
    ],
  • "rates": [
    ],
  • "rxValues": [
    ],
  • "waterAverageApplicationRate": 0.0000198,
  • "waterTotalApplication": 1.2212892,
  • "applicationZones": [
    ],
  • "fieldZones": null,
  • "dateCreated": "2021-01-18T15:55:01.560Z",
  • "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": [
    ],
  • "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

Authorizations:
OAuth2 (read:spraying)
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

$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

Content type
application/json
[
  • {
    }
]

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 (spraying)
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>

Responses

Request samples

Content type
application/json
{
  • "cropSeasonUuid": "ec8a3e6e-30ec-41b3-a007-adf2d87dc296",
  • "isAutoExecutable": true,
  • "plannedDate": "2019-04-03T16:42:23.000Z",
  • "executionDate": "2019-04-03T16:42:23.000Z",
  • "assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
  • "note": "A dummy note",
  • "assignmentState": "ACCEPTED",
  • "dosedMapUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
  • "availableDosedMaps": [
    ],
  • "asAppliedDosedMapUuid": "78af659c-fd01-4647-8a06-e075e9988296",
  • "recommendationUuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
  • "weedRecordUuid": "47983bd3-b41f-473a-9ec8-be94aefac1f5",
  • "fieldInputPackagingUuid": "5ed4f0bc-1be2-4e45-b722-db0dae7872e2"
}

Response samples

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:23.000Z",
  • "executionDate": "2019-04-03T16:42:23.000Z",
  • "autoExecutedOn": "2019-04-03T16:42:23.000Z",
  • "isAutoExecutable": true,
  • "assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
  • "note": "A dummy note",
  • "assignmentState": "ACCEPTED",
  • "state": "PLANNED",
  • "dateCreated": "2019-04-01T16:42:23.000Z",
  • "dosedMapUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
  • "availableDosedMaps": [
    ],
  • "asAppliedDosedMapUuid": "78af659c-fd01-4647-8a06-e075e9988296",
  • "recommendationUuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
  • "weedRecordUuid": "47983bd3-b41f-473a-9ec8-be94aefac1f5",
  • "fieldInputPackagingUuid": "5ed4f0bc-1be2-4e45-b722-db0dae7872e2",
  • "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]]]]}}]}"
}

Get single spraying

Authorizations:
OAuth2 (read:spraying)
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

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:23.000Z",
  • "executionDate": "2019-04-03T16:42:23.000Z",
  • "autoExecutedOn": "2019-04-03T16:42:23.000Z",
  • "isAutoExecutable": true,
  • "assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
  • "note": "A dummy note",
  • "assignmentState": "ACCEPTED",
  • "state": "PLANNED",
  • "dateCreated": "2019-04-01T16:42:23.000Z",
  • "dosedMapUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
  • "availableDosedMaps": [
    ],
  • "asAppliedDosedMapUuid": "78af659c-fd01-4647-8a06-e075e9988296",
  • "recommendationUuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
  • "weedRecordUuid": "47983bd3-b41f-473a-9ec8-be94aefac1f5",
  • "fieldInputPackagingUuid": "5ed4f0bc-1be2-4e45-b722-db0dae7872e2",
  • "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]]]]}}]}"
}

Update spraying

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

Authorizations:
OAuth2 (spraying)
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>

Responses

Request samples

Content type
application/merge-patch+json
{
  • "plannedDate": "2019-04-03T16:42:23.000Z",
  • "executionDate": "2019-04-03T16:42:23.000Z",
  • "isAutoExecutable": true,
  • "assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
  • "note": "A dummy note",
  • "assignmentState": "ACCEPTED",
  • "dosedMapUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
  • "availableDosedMaps": [
    ],
  • "asAppliedDosedMapUuid": "78af659c-fd01-4647-8a06-e075e9988296",
  • "recommendationUuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
  • "weedRecordUuid": "47983bd3-b41f-473a-9ec8-be94aefac1f5",
  • "fieldInputPackagingUuid": "5ed4f0bc-1be2-4e45-b722-db0dae7872e2"
}

Response samples

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:23.000Z",
  • "executionDate": "2019-04-03T16:42:23.000Z",
  • "autoExecutedOn": "2019-04-03T16:42:23.000Z",
  • "isAutoExecutable": true,
  • "assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
  • "note": "A dummy note",
  • "assignmentState": "ACCEPTED",
  • "state": "PLANNED",
  • "dateCreated": "2019-04-01T16:42:23.000Z",
  • "dosedMapUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
  • "availableDosedMaps": [
    ],
  • "asAppliedDosedMapUuid": "78af659c-fd01-4647-8a06-e075e9988296",
  • "recommendationUuid": "47553bd3-b41f-473a-9ec8-be94aefac1f5",
  • "weedRecordUuid": "47983bd3-b41f-473a-9ec8-be94aefac1f5",
  • "fieldInputPackagingUuid": "5ed4f0bc-1be2-4e45-b722-db0dae7872e2",
  • "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]]]]}}]}"
}

Delete spraying

Authorizations:
OAuth2 (spraying)
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 (observation)
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

Content type
application/json
{
  • "cropSeasonUuid": "ec8a3e6e-30ec-41b3-a007-adf2d87dc296",
  • "executionDate": { },
  • "importantStageUuid": "6c8a42be-1bc5-47a0-b671-251045e04a61",
  • "stressAnswerUuids": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Get observation

Authorizations:
OAuth2 (read:observation)
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

Content type
application/json
[
  • {
    }
]

Delete observation

Authorizations:
OAuth2 (observation)
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 (read:watermanagementtask)
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

Content type
application/json
[
  • {
    }
]

Create a water management task

Authorizations:
OAuth2 (watermanagementtask)
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.

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

Responses

Request samples

Content type
application/json
{
  • "cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80",
  • "type": "IRRIGATION",
  • "plannedDate": "2019-04-03T16:42:23.000Z",
  • "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:23.000Z",
  • "fieldCoveragePercentage": 45.1,
  • "taskMethodUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80"
}

Response samples

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:23.000Z",
  • "executionDate": null,
  • "autoExecutedOn": "2019-04-03T16:42:23.000Z",
  • "isAutoExecutable": true,
  • "assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
  • "note": "A dummy note",
  • "assignmentState": "ACCEPTED",
  • "state": "PLANNED",
  • "dateCreated": "2019-04-01T16:42:23.000Z",
  • "type": "IRRIGATION",
  • "waterHeightDifference": 0.2,
  • "waterHeight": 1.2,
  • "executionStartDate": "2022-04-03T16:42:23.000Z",
  • "fieldCoveragePercentage": 45.1,
  • "taskMethodUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80"
}

Get single water management task

Authorizations:
OAuth2 (read:watermanagementtask)
path Parameters
uuid
required
string <uuid>
Example: 199067a9-5bb1-4f20-9641-a35d5ce31e19

Define resource by uuid

Responses

Response samples

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:23.000Z",
  • "executionDate": null,
  • "autoExecutedOn": "2019-04-03T16:42:23.000Z",
  • "isAutoExecutable": true,
  • "assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
  • "note": "A dummy note",
  • "assignmentState": "ACCEPTED",
  • "state": "PLANNED",
  • "dateCreated": "2019-04-01T16:42:23.000Z",
  • "type": "IRRIGATION",
  • "waterHeightDifference": 0.2,
  • "waterHeight": 1.2,
  • "executionStartDate": "2022-04-03T16:42:23.000Z",
  • "fieldCoveragePercentage": 45.1,
  • "taskMethodUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80"
}

Update water management task

Authorizations:
OAuth2 (watermanagementtask)
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.

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

Responses

Request samples

Content type
application/merge-patch+json
{
  • "plannedDate": "2019-04-03T16:42:23.000Z",
  • "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:23.000Z",
  • "fieldCoveragePercentage": 45.1,
  • "taskMethodUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80"
}

Response samples

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:23.000Z",
  • "executionDate": null,
  • "autoExecutedOn": "2019-04-03T16:42:23.000Z",
  • "isAutoExecutable": true,
  • "assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
  • "note": "A dummy note",
  • "assignmentState": "ACCEPTED",
  • "state": "PLANNED",
  • "dateCreated": "2019-04-01T16:42:23.000Z",
  • "type": "IRRIGATION",
  • "waterHeightDifference": 0.2,
  • "waterHeight": 1.2,
  • "executionStartDate": "2022-04-03T16:42:23.000Z",
  • "fieldCoveragePercentage": 45.1,
  • "taskMethodUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80"
}

Delete a water management task

Authorizations:
OAuth2 (watermanagementtask)
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 (seedtreatment)
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

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

Response samples

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:23.000Z",
  • "executionDate": "2019-04-03T16:42:23.000Z",
  • "autoExecutedOn": "2019-04-03T16:42:23.000Z",
  • "isAutoExecutable": true,
  • "assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
  • "note": "A dummy note",
  • "assignmentState": "ACCEPTED",
  • "state": "PLANNED",
  • "dateCreated": "2019-04-01T16:42:23.000Z",
  • "totalLiquidRate": 0.03,
  • "products": [
    ],
  • "taskMethodUuid": "POWDERING",
  • "recipe": [
    ]
}

Get seed treatment tasks

Authorizations:
OAuth2 (read:seedtreatment)
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

Content type
application/json
[
  • {
    }
]

Get single seed treatment task

Authorizations:
OAuth2 (read:seedtreatment)
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

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:23.000Z",
  • "executionDate": "2019-04-03T16:42:23.000Z",
  • "autoExecutedOn": "2019-04-03T16:42:23.000Z",
  • "isAutoExecutable": true,
  • "assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
  • "note": "A dummy note",
  • "assignmentState": "ACCEPTED",
  • "state": "PLANNED",
  • "dateCreated": "2019-04-01T16:42:23.000Z",
  • "totalLiquidRate": 0.03,
  • "products": [
    ],
  • "taskMethodUuid": "POWDERING",
  • "recipe": [
    ]
}

Update seed treatment task

Authorizations:
OAuth2 (seedtreatment)
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

Content type
application/merge-patch+json
{
  • "plannedDate": "2019-04-03T16:42:23.000Z",
  • "executionDate": "2019-04-03T16:42:23.000Z",
  • "isAutoExecutable": true,
  • "assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
  • "note": "A dummy note",
  • "assignmentState": "ACCEPTED",
  • "totalLiquidRate": 0.03,
  • "products": [
    ],
  • "taskMethodUuid": "POWDERING"
}

Response samples

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:23.000Z",
  • "executionDate": "2019-04-03T16:42:23.000Z",
  • "autoExecutedOn": "2019-04-03T16:42:23.000Z",
  • "isAutoExecutable": true,
  • "assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
  • "note": "A dummy note",
  • "assignmentState": "ACCEPTED",
  • "state": "PLANNED",
  • "dateCreated": "2019-04-01T16:42:23.000Z",
  • "totalLiquidRate": 0.03,
  • "products": [
    ],
  • "taskMethodUuid": "POWDERING",
  • "recipe": [
    ]
}

Delete a seed treatment task

Authorizations:
OAuth2 (seedtreatment)
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 (seedboxtreatment)
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

Content type
application/json
{
  • "cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef806",
  • "autoExecutedOn": "2019-04-03T16:42:23.000Z",
  • "plannedDate": "2019-04-03T16:42:23.000Z",
  • "executionDate": "2019-04-03T16:42:23.000Z",
  • "isAutoExecutable": true,
  • "assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
  • "note": "A dummy note",
  • "assignmentState": "ACCEPTED",
  • "totalLiquidRate": 0.03,
  • "products": [
    ],
  • "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

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:23.000Z",
  • "executionDate": "2019-04-03T16:42:23.000Z",
  • "autoExecutedOn": "2019-04-03T16:42:23.000Z",
  • "isAutoExecutable": true,
  • "assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
  • "note": "A dummy note",
  • "assignmentState": "ACCEPTED",
  • "state": "PLANNED",
  • "dateCreated": "2019-04-01T16:42:23.000Z",
  • "totalLiquidRate": 0.03,
  • "products": [
    ],
  • "taskMethodUuid": "a8cd4c5a-392d-4685-89df-b4e5df09954c",
  • "applicationSpotUuid": "58cd4c5a-392d-4685-89df-b4e5df09954a",
  • "recipe": [
    ],
  • "totalLiquidLocalUnitUuid": "bedc4521-6797-4f57-8437-a539c5dea0b1",
  • "waterLocalUnitUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80"
}

Get seed box treatment tasks

Authorizations:
OAuth2 (read:seedboxtreatment)
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

Content type
application/json
[
  • {
    }
]

Get single seed box treatment task

Authorizations:
OAuth2 (read:seedboxtreatment)
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

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:23.000Z",
  • "executionDate": "2019-04-03T16:42:23.000Z",
  • "autoExecutedOn": "2019-04-03T16:42:23.000Z",
  • "isAutoExecutable": true,
  • "assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
  • "note": "A dummy note",
  • "assignmentState": "ACCEPTED",
  • "state": "PLANNED",
  • "dateCreated": "2019-04-01T16:42:23.000Z",
  • "totalLiquidRate": 0.03,
  • "products": [
    ],
  • "taskMethodUuid": "a8cd4c5a-392d-4685-89df-b4e5df09954c",
  • "applicationSpotUuid": "58cd4c5a-392d-4685-89df-b4e5df09954a",
  • "recipe": [
    ],
  • "totalLiquidLocalUnitUuid": "bedc4521-6797-4f57-8437-a539c5dea0b1",
  • "waterLocalUnitUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80"
}

Update seed box treatment task

Authorizations:
OAuth2 (seedboxtreatment)
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

Content type
application/merge-patch+json
{
  • "plannedDate": "2019-04-03T16:42:23.000Z",
  • "executionDate": "2019-04-03T16:42:23.000Z",
  • "isAutoExecutable": true,
  • "assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
  • "note": "A dummy note",
  • "assignmentState": "ACCEPTED",
  • "totalLiquidRate": 0.03,
  • "products": [
    ],
  • "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

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:23.000Z",
  • "executionDate": "2019-04-03T16:42:23.000Z",
  • "autoExecutedOn": "2019-04-03T16:42:23.000Z",
  • "isAutoExecutable": true,
  • "assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
  • "note": "A dummy note",
  • "assignmentState": "ACCEPTED",
  • "state": "PLANNED",
  • "dateCreated": "2019-04-01T16:42:23.000Z",
  • "totalLiquidRate": 0.03,
  • "products": [
    ],
  • "taskMethodUuid": "a8cd4c5a-392d-4685-89df-b4e5df09954c",
  • "applicationSpotUuid": "58cd4c5a-392d-4685-89df-b4e5df09954a",
  • "recipe": [
    ],
  • "totalLiquidLocalUnitUuid": "bedc4521-6797-4f57-8437-a539c5dea0b1",
  • "waterLocalUnitUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef80"
}

Delete a seed box treatment task

Authorizations:
OAuth2 (seedboxtreatment)
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 (read:landpreparation)
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

Content type
application/json
[
  • {
    }
]

Create a land preparation task

At least one of tillageUuid or drainagePreparationUuid is mandatory.

Authorizations:
OAuth2 (landpreparation)
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

Content type
application/json
{
  • "cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef806",
  • "autoExecutedOn": "2019-04-03T16:42:23.000Z",
  • "plannedDate": "2019-04-03T16:42:23.000Z",
  • "executionDate": "2019-04-03T16:42:23.000Z",
  • "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

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:23.000Z",
  • "executionDate": "2019-04-03T16:42:23.000Z",
  • "autoExecutedOn": "2019-04-03T16:42:23.000Z",
  • "isAutoExecutable": true,
  • "assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
  • "note": "A dummy note",
  • "assignmentState": "ACCEPTED",
  • "state": "PLANNED",
  • "dateCreated": "2019-04-01T16:42:23.000Z",
  • "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 (landpreparation)
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

Content type
application/merge-patch+json
{
  • "plannedDate": "2019-04-03T16:42:23.000Z",
  • "executionDate": "2019-04-03T16:42:23.000Z",
  • "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

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:23.000Z",
  • "executionDate": "2019-04-03T16:42:23.000Z",
  • "autoExecutedOn": "2019-04-03T16:42:23.000Z",
  • "isAutoExecutable": true,
  • "assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
  • "note": "A dummy note",
  • "assignmentState": "ACCEPTED",
  • "state": "PLANNED",
  • "dateCreated": "2019-04-01T16:42:23.000Z",
  • "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 (read:landpreparation)
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

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:23.000Z",
  • "executionDate": "2019-04-03T16:42:23.000Z",
  • "autoExecutedOn": "2019-04-03T16:42:23.000Z",
  • "isAutoExecutable": true,
  • "assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
  • "note": "A dummy note",
  • "assignmentState": "ACCEPTED",
  • "state": "PLANNED",
  • "dateCreated": "2019-04-01T16:42:23.000Z",
  • "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 (landpreparation)
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 (read:cropresiduemanagementtask)
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

Content type
application/json
[
  • {
    }
]

Create a crop residue management task

Creates a crop residue management task, cropSeasonUuid is mandatory.

Authorizations:
OAuth2 (cropresiduemanagementtask)
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

Content type
application/json
{
  • "cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef806",
  • "autoExecutedOn": "2019-04-03T16:42:23.000Z",
  • "plannedDate": "2019-04-03T16:42:23.000Z",
  • "executionDate": "2019-04-03T16:42:23.000Z",
  • "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

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:23.000Z",
  • "executionDate": "2019-04-03T16:42:23.000Z",
  • "autoExecutedOn": "2019-04-03T16:42:23.000Z",
  • "isAutoExecutable": true,
  • "assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
  • "note": "A dummy note",
  • "assignmentState": "ACCEPTED",
  • "state": "PLANNED",
  • "dateCreated": "2019-04-01T16:42:23.000Z",
  • "residueManagementUuid": "a8cd4c5a-392d-4685-89df-b4e5df09954c",
  • "area": 14.3
}

Patch an existing crop residue management task

Authorizations:
OAuth2 (cropresiduemanagementtask)
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

Content type
application/merge-patch+json
{
  • "plannedDate": "2019-04-03T16:42:23.000Z",
  • "executionDate": "2019-04-03T16:42:23.000Z",
  • "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

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:23.000Z",
  • "executionDate": "2019-04-03T16:42:23.000Z",
  • "autoExecutedOn": "2019-04-03T16:42:23.000Z",
  • "isAutoExecutable": true,
  • "assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
  • "note": "A dummy note",
  • "assignmentState": "ACCEPTED",
  • "state": "PLANNED",
  • "dateCreated": "2019-04-01T16:42:23.000Z",
  • "residueManagementUuid": "a8cd4c5a-392d-4685-89df-b4e5df09954c",
  • "area": 14.3
}

Get a crop residue management task by uuid

Authorizations:
OAuth2 (read:cropresiduemanagementtask)
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

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:23.000Z",
  • "executionDate": "2019-04-03T16:42:23.000Z",
  • "autoExecutedOn": "2019-04-03T16:42:23.000Z",
  • "isAutoExecutable": true,
  • "assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
  • "note": "A dummy note",
  • "assignmentState": "ACCEPTED",
  • "state": "PLANNED",
  • "dateCreated": "2019-04-01T16:42:23.000Z",
  • "residueManagementUuid": "a8cd4c5a-392d-4685-89df-b4e5df09954c",
  • "area": 14.3
}

Delete a crop residue management task

Authorizations:
OAuth2 (cropresiduemanagementtask)
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 (read:harvest)
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

Content type
application/json
[
  • {
    }
]

Create a harvest

Authorizations:
OAuth2 (harvest)
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
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"
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.

Responses

Request samples

Content type
application/json
{
  • "cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef806",
  • "plannedDate": { },
  • "executionDate": "2019-04-03T16:42:23.000Z",
  • "isAutoExecutable": true,
  • "assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
  • "note": "A dummy note",
  • "assignmentState": "ACCEPTED",
  • "yieldProperties": {
    },
  • "harvestMethodCode": "PLUCK",
  • "harvestedProduceCode": "GRAIN",
  • "yield": 1.2
}

Response samples

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:23.000Z",
  • "executionDate": "2019-04-03T16:42:23.000Z",
  • "autoExecutedOn": "2019-04-03T16:42:23.000Z",
  • "isAutoExecutable": true,
  • "assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
  • "note": "A dummy note",
  • "assignmentState": "ACCEPTED",
  • "state": "PLANNED",
  • "dateCreated": "2019-04-01T16:42:23.000Z",
  • "yieldProperties": {
    },
  • "harvestMethodCode": "PLUCK",
  • "harvestedProduceCode": "GRAIN",
  • "yield": 1.2,
  • "isSingleHarvestOnly": true
}

Patch an existing harvest

Authorizations:
OAuth2 (harvest)
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
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"
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.

Responses

Request samples

Content type
application/merge-patch+json
{
  • "plannedDate": "2019-04-03T16:42:23.000Z",
  • "executionDate": "2019-04-03T16:42:23.000Z",
  • "isAutoExecutable": true,
  • "assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
  • "note": "A dummy note",
  • "assignmentState": "ACCEPTED",
  • "yieldProperties": {
    },
  • "harvestMethodCode": "PLUCK",
  • "harvestedProduceCode": "GRAIN",
  • "yield": 1.2
}

Response samples

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:23.000Z",
  • "executionDate": "2019-04-03T16:42:23.000Z",
  • "autoExecutedOn": "2019-04-03T16:42:23.000Z",
  • "isAutoExecutable": true,
  • "assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
  • "note": "A dummy note",
  • "assignmentState": "ACCEPTED",
  • "state": "PLANNED",
  • "dateCreated": "2019-04-01T16:42:23.000Z",
  • "yieldProperties": {
    },
  • "harvestMethodCode": "PLUCK",
  • "harvestedProduceCode": "GRAIN",
  • "yield": 1.2,
  • "isSingleHarvestOnly": true
}

Get a harvest by uuid

Authorizations:
OAuth2 (read:harvest)
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

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:23.000Z",
  • "executionDate": "2019-04-03T16:42:23.000Z",
  • "autoExecutedOn": "2019-04-03T16:42:23.000Z",
  • "isAutoExecutable": true,
  • "assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
  • "note": "A dummy note",
  • "assignmentState": "ACCEPTED",
  • "state": "PLANNED",
  • "dateCreated": "2019-04-01T16:42:23.000Z",
  • "yieldProperties": {
    },
  • "harvestMethodCode": "PLUCK",
  • "harvestedProduceCode": "GRAIN",
  • "yield": 1.2,
  • "isSingleHarvestOnly": true
}

Delete a harvest.

Authorizations:
OAuth2 (harvest)
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 (read:soilsampling)
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

Content type
application/json
[
  • {
    }
]

Create a soil sampling task

Authorizations:
OAuth2 (soilsampling)
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

Content type
application/json
{
  • "cropSeasonUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef806",
  • "soilSamplingSetUuid": "2a84e031-c5c6-4fcf-95f6-1341c5ebef806",
  • "sampledPoints": [
    ],
  • "plannedDate": "2019-04-03T16:42:23.000Z",
  • "executionDate": "2019-04-03T16:42:23.000Z",
  • "assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
  • "note": "A dummy note",
  • "assignmentState": "ACCEPTED"
}

Response samples

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": [
    ],
  • "plannedDate": "2019-04-03T16:42:23.000Z",
  • "executionDate": "2019-04-03T16:42:23.000Z",
  • "assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
  • "note": "A dummy note",
  • "assignmentState": "ACCEPTED",
  • "state": "PLANNED"
}

Patch an existing soil sampling task

Authorizations:
OAuth2 (soilsampling)
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

Content type
application/merge-patch+json
{
  • "sampledPoints": [
    ],
  • "plannedDate": "2019-04-03T16:42:23.000Z",
  • "executionDate": "2019-04-03T16:42:23.000Z",
  • "assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
  • "note": "A dummy note",
  • "assignmentState": "ACCEPTED"
}

Response samples

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": [
    ],
  • "plannedDate": "2019-04-03T16:42:23.000Z",
  • "executionDate": "2019-04-03T16:42:23.000Z",
  • "assigneeUuid": "58cd4c5a-392d-4685-89df-b4e5df09954c",
  • "note": "A dummy note",
  • "assignmentState": "ACCEPTED",
  • "state": "PLANNED"
}

Delete a soil sampling task

Authorizations:
OAuth2 (soilsampling)
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

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

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 (read:growthstageprediction)
query Parameters
includeOverlappedGrowthStage
boolean
Default: false
Example: includeOverlappedGrowthStage=true

return response with/without overlapping growthstages.

convertToScale
string
Enum: "BBCH" "ISU" "ZADOKS"
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:

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:

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

Content type
application/json
[
  • {
    }
]

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 (read:growthstageprediction)
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

Content type
application/json
[
  • {
    }
]

Shop service

Shop service handles orders, vouchers and licenses.

Create a partner order

Prepare an order.

Authorizations:
OAuth2 (partnerorder)
Request Body schema: application/json
farmUuid
required
string or null <uuid>
voucherCode
required
string
required
object

User address

vatId
string

Responses

Request samples

Content type
application/json
{
  • "farmUuid": "m1dc4521-6797-4f57-8437-a539c5dea0f9",
  • "voucherCode": "VOUCHERSHOPX",
  • "customerAddress": {
    },
  • "vatId": 12345
}

Response samples

Content type
application/json
{
  • "uuid": "m1dc4521-6797-4f57-8437-a539c5dea0f9",
  • "farmUuid": "m1dc4521-6797-4f57-8437-a539c5dea0f9",
  • "voucherCode": "VOUCHERSHOPX",
  • "customerAddress": {
    },
  • "vatId": 12345
}

Retrieve partner orders

Retrieve orders by farm.

Authorizations:
OAuth2 (read:partnerorder)
query Parameters
farmUuid
Array of strings <uuid>
Example: farmUuid=9b4ee6b2-ae2d-6c9a-af77-08a4b749031f

Filter by farm uuid

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get single partner order

Authorizations:
OAuth2 (read:partnerorder)
path Parameters
uuid
required
string <uuid>
Example: 199067a9-5bb1-4f20-9641-a35d5ce31e19

Define resource by uuid

Responses

Response samples

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

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

Content type
application/json
{
  • "farmUuid": "m1dc4521-6797-4f57-8437-a539c5dea0f9",
  • "seller": "BASF_DIGITAL_FARMING",
  • "voucherCode": "VOUCHERSHOPX",
  • "withDynamicPricing": true,
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "baseTotal": 120,
  • "discountAmount": 20,
  • "payableAmount": 114,
  • "currencyCode": "EUR",
  • "voucherCode": "VOUCHERSHOPX",
  • "items": {
    }
}

Crop

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

Get available crops

Authorizations:
OAuth2 (read:partnercrop)
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

Content type
application/json
[
  • {
    }
]

Product

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

Get available products

Authorizations:
OAuth2 (read:partnerproduct)
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:

Default is today in UTC. Filter by product expiry date or last commercial use date >= applicationDate.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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 (read:partnertillage)
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

Content type
application/json
[
  • {
    }
]

Variety

Either uuid, code, or countryIso2Code filter is required.

Get available varieties

Authorizations:
OAuth2 (read:partnervariety)
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

Content type
application/json
[
  • {
    }
]

Stress

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

Get available stresses

Authorizations:
OAuth2 (read:partnerstress)
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

Content type
application/json
[
  • {
    }
]

Action Recommendation Aggregation

An aggregation of all recommendations for a field

Get all aggregated action recommendations, for a crop season

Authorizations:
OAuth2 (read:actionrecommendationaggregation)
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

Content type
application/json
[
  • {
    }
]

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 (read:nutritionstatus)
query Parameters
cropSeasonUuid
required
string <uuid>
Example: cropSeasonUuid=2a84e031-c5c6-4fcf-95f6-1341c5ebef80

Filter by cropseason uuid

fromDate
string <date-time>
Example:

from date

tillDate
string <date-time>
Example:

till date

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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 (read:nutritionrecommendation)
query Parameters
cropSeasonUuid
required
string <uuid>
Example: cropSeasonUuid=2a84e031-c5c6-4fcf-95f6-1341c5ebef80

Filter by cropseason uuid

fromDate
string <date-time>
Example:

from date

tillDate
string <date-time>
Example:

till date

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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 (read:waterstatus)
query Parameters
cropSeasonUuid
required
Array of strings <uuid>
Example: cropSeasonUuid=2a84e031-c5c6-4fcf-95f6-1341c5ebef80

Filter by cropseason uuid

fromDate
string <date-time>
Example:

from date

tillDate
string <date-time>
Example:

till date

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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 (read:waterrecommendation)
query Parameters
cropSeasonUuid
required
Array of strings <uuid>
Example: cropSeasonUuid=2a84e031-c5c6-4fcf-95f6-1341c5ebef80

Filter by cropseason uuid

fromDate
string <date-time>
Example:

from date

tillDate
string <date-time>
Example:

till date

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Field Entries

Field entries

Create field entry

Authorizations:
OAuth2 (fieldentry)
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

Content type
application/json
{
  • "fieldUuid": "4dfc2bed-21f4-490e-acf1-d0cebafb7185",
  • "name": "#1",
  • "location": {
    }
}

Response samples

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": {
    }
}

List field entries

get field entries. At least one parameter is required.

Authorizations:
OAuth2 (read:fieldentry)
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

Content type
application/json
[
  • {
    }
]

Get field entry

Authorizations:
OAuth2 (read:fieldentry)
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

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": {
    }
}

Delete field entry

Authorizations:
OAuth2 (fieldentry)
path Parameters
uuid
required
string <uuid>
Example: 199067a9-5bb1-4f20-9641-a35d5ce31e19

Define resource by uuid

Responses

Update field entry

Authorizations:
OAuth2 (fieldentry)
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

Content type
application/merge-patch+json
{
  • "name": "#1",
  • "location": {
    }
}

Response samples

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": {
    }
}

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 (cropseasonstatusreport)
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

Content type
application/json
{
  • "locale": "EN_GB",
  • "cropSeasonUuids": [
    ],
  • "theme": "XARVIO",
  • "sections": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "8f0fd948-6c02-41de-a017-e7d8fca46956",
  • "pdfUrl": "http://example.com",
  • "locale": "EN_GB",
  • "cropSeasonUuids": [
    ],
  • "theme": "XARVIO",
  • "sections": {
    }
}

Download customized crop season status report

Authorizations:
OAuth2 (read:cropseasonstatusreport)
path Parameters
uuid
required
string <uuid>
Example: 199067a9-5bb1-4f20-9641-a35d5ce31e19

Define resource by uuid

Responses

Response samples

Content type
application/json
{
  • "statusCode": 400,
  • "messages": [
    ],
  • "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 (read:soilsampling)
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

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": [
    ],
  • "plannedDate": "2019-04-03T16:42:23.000Z",
  • "executionDate": "2019-04-03T16:42:23.000Z",
  • "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 (read:residualactivation)
query Parameters
sprayingUuid
required
Array of strings <uuid>
Example: sprayingUuid=199067a9-5bb1-4f20-9641-a35d5ce31e19

Filter by sprayingUuid

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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 (read:residualactivation)
query Parameters
cropSeasonUuid
required
Array of strings <uuid>
Example: cropSeasonUuid=2a84e031-c5c6-4fcf-95f6-1341c5ebef80

Filter by cropseason uuid

Responses

Response samples

Content type
application/json
[
  • {
    }
]