This endpoint is used to create a field in the system.
Payload is a JSON object (or array of objects) containing the following keys:
-
boundary: it defines the boundary of the field. It is a GeoJSON Feature, same as the input payload for POST /boundaries endpoint.
- Note: permissions will be applied to the boundary reference while the field boundary will always be visible by any tenant.
-
boundary_id: alternatively, you can pass the ID of an existing boundary instead of geometry payload (id from response of POST /boundaries endpoint).
- Note: you need to provide either boundary or boundary_id.
- Note: provided boundary will be made public.
-
effective_from: The date from which the boundary of the field is active (optional).
- Default: now()
- Formats: YYYY-MM-DD, YYYY-MM-DDThh:mm:ss
- Value: inclusive
-
autoedit: It dictates if the input geometry can be modified or not, if necessary, to make it fit into Varda default layer of field boundaries (optional, default=false).
-
autoreplace: Boolean parameter that enables you to specify whether the system should set to expire the existing field boundaries that would otherwise overlap with the field boundary about to be created, thus causing the creation pocess to fail (optional, default=false).
-
name: The name of the field (optional, default='').
-
description: The description of the field (optional, default='').
The output is a JSON object (or array of objects) containing following data:
- field_id: The ID that the system assigned to the field.
- active_boundary_id: The ID of the "active boundary according to Varda" created out of the "boundary according to the source".
- created_at: The time when the field got created in the system.
- effective_from, effective_to: Current lifetime range of the field.
When payload contains an array the request will succeed only if all items will be registered as fields.
Query parameter "dry_run" (optional, default=false) allows to simulate request outcome without applying changes to the data. Responses when dry_run=true are HTTP204 on success or error (including details) on failure
Note: GeoJSON numeric precision will be limited to 15 decimal places.
Note: Please reach out to our support team if you want to get access to this endpoint.