From bd57ff9ece3e0041d6cbb0a7665763d15d26f63b Mon Sep 17 00:00:00 2001 From: Wilco Krikke Date: Fri, 28 May 2021 14:16:01 +0000 Subject: [PATCH] Add 'Blight-API.md' --- Blight-API.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 Blight-API.md diff --git a/Blight-API.md b/Blight-API.md new file mode 100644 index 0000000..50bd972 --- /dev/null +++ b/Blight-API.md @@ -0,0 +1,23 @@ +## Blight API +[<< Home](README.md) + +For the currently available public FarmMaps API you can take a look at swagger: https://test.farmmaps.eu/swagger + + +## API flow +* Authenticate User +* Optional steps + * *Create cropfield through FarmMaps API* + * Item 'vnd.farmmaps.itemtype.cropfield' must be created with its data as specified in the api. + * Task 'vnd.farmmaps.task.workflow' can be executed if needed executed to aggregate all needed data. + * This is an asynchronous process and can take a while before all data is collected in FarmMaps. + +* Task 'vnd.farmmaps.task.blight' must be executed to create an advice. This task is automatically created for crop fields with potato and is scheduled to run at configered times to keep the advice updated. +It is also possible to executed this task at any time through the API. This will be explained in the following chapters. + +**Users can poll the task api to see if a task is completed** +**This can be achieved with the task execution id obtained from calling the 'ItemTask' API.** +[Poll task status](Polling-task-status.md) + + +**Users can query the API for child items of a cropfield to see what items it has.**