FarmMaps/Documentatie
8
0
Fork 0
Code Pull Requests Releases Activity

Added extra explanation of input parameters.

Browse Source
This commit is contained in:
Mark van der Wal 2020-05-11 12:19:49 +02:00
parent d2f7c089dc
commit 6aa98c3d02
1 changed files with 27 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
VRAHaulmkilling-API.md
View File

@ -183,12 +183,33 @@ Each constant value object has an **'option'** associated with it that should al
###### Creating an application map with the VRAHaulmkilling task
Execute the task with the item code of the cropfield as parameter inside {code}.
Use the input map code inside {itemCode}, specifying an inputCode for the input data item.
Use the code of the input item inside {itemCode}, this specifies an item to use as input.
{itemCode} needs the code of the data input item passed into it.
**'inputCode'** needs to have a value that is gotten from the haulmkilling agent query.
**'agentName'** needs to have a value that is gotten from the haulmkilling agent query.
**'inputType'** needs to have a value that is gotten from the haulmkilling agent query.
**'selectedOption'** needs to have a value that is gotten from the haulmkilling agent query.
The given agent values(agentName, inputType and selectedOption) as specified above form a unique combination specifying correct agent data.
For example, the agent with **'agentName'** needs to have an entry of **'inputType'** with a constant object with the **"option"** key and value **'selectedOption'**.
```javascript
{
"name": "<agentName>",
"values": {
"<inputType>": [
{
"max": 0.9,
"min": 0.25,
"fexp": 2.97,
"fmul": 0.25,
"option": "<selectedOption>"
}
]
}
}
```
The resulting application map will be created as a child item of the cropfield item (this can be queried).
The resulting application map will be created as a child item of the cropfield item (this item can be queried).
> Request
```javascript
POST /api/v1/items/{code}/tasks
@ -221,6 +242,9 @@ Response 401 Not authenticated
Response 403 No WRITE permissions in item
Response 404 Item not found
##### Optional input parameters #####
There are some optional input parameters for greater flexibility.
##### Create taskmap
[Create Taskmap](Create-Taskmap.md)