216 lines
7.3 KiB
Markdown
216 lines
7.3 KiB
Markdown
## Creating a cropfield
|
|
This page explains what a cropfield is, and how to create one through the API.
|
|
|
|
Agricultural datasets generally refer to a specif crop, at a specific location at a specific time.
|
|
Therefore, we need to create a "Cropfield" item, to define this location and a timeframe our data relates to.
|
|
A cropfield provides a convienient way to group all data for a crop grown on a specific plot during a season.
|
|
Farmmaps also uses the cropfield to collect and prepare context data such as weather, satelite imagery etc.
|
|
|
|
To create a cropfield we:
|
|
* Get the parent folder to place the cropfield under
|
|
* Create a folder under this element (optional)
|
|
* Create the cropfield
|
|
|
|
**Prerequisites**
|
|
To create a cropfield we need:
|
|
|
|
* an acces token
|
|
* coordinates of the cropfield (what points define the plot contour)
|
|
* a startdate and an end date (what timeframe does this data aply to)
|
|
|
|
### Get parent element
|
|
First, we'll get the parent code needed to place the cropfield in the hierarchy.
|
|
|
|
**Request**
|
|
Replace `<acces token>` with your actual token.
|
|
```http
|
|
GET https://farmmaps.awacc.nl/api/v1/folders/my_drive? HTTP/1.1
|
|
Host: farmmaps.awacc.nl
|
|
Accept: application/json
|
|
Authorization: Bearer <access token>
|
|
```
|
|
|
|
**Response**
|
|
The response will be something similar to:
|
|
|
|
```http
|
|
HTTP/1.1 200 OK
|
|
Server: nginx/1.14.0 (Ubuntu)
|
|
Date: Tue, 21 Apr 2020 09:57:07 GMT
|
|
Content-Type: application/json; charset=utf-8
|
|
Transfer-Encoding: chunked
|
|
Connection: keep-alive
|
|
Cache-Control: no-store,no-cache
|
|
Pragma: no-cache
|
|
Content-Encoding: br
|
|
Vary: Accept-Encoding
|
|
|
|
```
|
|
So the `parentcode` we need is **"f25d8765a1cd407cb235961c73c268cf:USER_FILES"**
|
|
You can also find the code of a folder by browsing the folders in your FarmMaps account through the web interface.
|
|
The item code is the last part of the URL.
|
|
|
|
### Create folder
|
|
Depending on how you want to organise things, you might choose to make a separate folder for the cropfield.
|
|
A folder can be created by creating an item with itemType `FOLDER`.
|
|
|
|
> **Note:** At the moment, subfolders can not be created directly under the root folder, create a folder through the web interface first.
|
|
|
|
**Request**
|
|
```http
|
|
POST /api/v1/items HTTP/1.1
|
|
Accept: application/json
|
|
Authorization: Bearer <access token>
|
|
Content-Type: application/json
|
|
Cache-Control: no-cache
|
|
Host: farmmaps.awacc.nl
|
|
Accept-Encoding: gzip, deflate, br
|
|
Connection: keep-alive
|
|
Content-Length: 210
|
|
|
|
```
|
|
|
|
When the folder is created successfully we should recieve something like this:
|
|
|
|
**Response**
|
|
```http
|
|
{
|
|
"parentCode": "string",
|
|
"geometry": {},
|
|
"data": {},
|
|
"tags": [
|
|
"string"
|
|
],
|
|
"url": "string",
|
|
"code": "string",
|
|
"name": "My_new_folder",
|
|
"created": "2019-12-18T10:16:21.455Z",
|
|
"updated": "2019-12-18T10:16:21.455Z",
|
|
"dataDate": "2019-12-18T10:16:21.455Z",
|
|
"itemType": "string",
|
|
"sourceTask": "string",
|
|
"size": 0,
|
|
"state": 0,
|
|
"thumbnail": true
|
|
}
|
|
```
|
|
|
|
### Create the cropfield
|
|
Now we can create the cropfield. We do so by setting `"itemType": "vnd.farmmaps.itemtype.cropfield"` and adding data to the geometry parameter.
|
|
Generally, a cropfield contour would be defined as a polygon, so we add `"type":"Polygon" and all the coordinates.
|
|
We also need to specify a `dataDate` and a `dataEndDate` to indicate the the timeframe of the growing season.
|
|
The `dataDate` needs to be before `dataEndDate` and cannot be on the same day.
|
|
|
|
**Request**
|
|
|
|
```http
|
|
POST /api/v1/items HTTP/1.1
|
|
Accept: application/json
|
|
Authorization: Bearer <acces token>
|
|
Content-Type: application/json
|
|
Cache-Control: no-cache
|
|
Host: farmmaps.awacc.nl
|
|
Accept-Encoding: gzip, deflate, br
|
|
Connection: keep-alive
|
|
Content-Length: 916
|
|
|
|
```
|
|
|
|
**Response**
|
|
When the cropfield is created, it should be visible through the FarmMaps web interface (under "My Drive" in the respective parent folder).
|
|
We should have the following response:
|
|
|
|
```http
|
|
HTTP/1.1 201 Created
|
|
Server: nginx/1.14.0 (Ubuntu)
|
|
Date: Fri, 24 Apr 2020 08:56:45 GMT
|
|
Content-Type: application/json; charset=utf-8
|
|
Transfer-Encoding: chunked
|
|
Connection: keep-alive
|
|
Cache-Control: no-store,no-cache
|
|
Pragma: no-cache
|
|
Content-Encoding: br
|
|
Location: /api/v1/items/8ecbaa2d85d5484db7f16b281b7cd013
|
|
Vary: Accept-Encoding
|
|
|
|
```
|
|
|
|
**Troubleshooting**
|
|
|Status code|Description|
|
|
|---|---|
|
|
|201|Cropfield created successfully|
|
|
|401|Error: not authenticated|
|
|
|403|Error: No write permissions in parent item|
|
|
|404|Error: Parent item not found|
|
|
|
|
Now that the cropfield has been created, we can start the processing by running a task.
|
|
This will collext all context data for the cropfield.
|
|
We need the ItemCode of the cropfield to start the task so keep this at hand.
|
|
|