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

fixed placement of extra explanation of attribute input parameters.

master
Mark van der Wal 2020-05-11 12:44:52 +02:00
parent 712026d9ae
commit 9b23942afa
1 changed files with 25 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
VRAHaulmkilling-API.md
View File

@ -183,31 +183,7 @@ 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 code of the input item inside {itemCode}, this specifies an item to use as input.
**'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>"
}
]
}
}
```
Use the code of the input item inside {itemCode}, this specifies an item to use as input.
The resulting application map will be created as a child item of the cropfield item (this item can be queried).
> Request
@ -242,6 +218,30 @@ Response 401 Not authenticated
Response 403 No WRITE permissions in item
Response 404 Item not found
**'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>"
}
]
}
}
```
##### Optional input parameters #####
There are some optional task attribute input parameters for greater flexibility.