Documentation Powered by Redocly

Field level maps (with shortcuts) (with-shortcuts)

Download OpenAPI specification:Download

GEOSYS™ Map Product APIs provide endpoints for retrieving map image coverage and map generation.

AdvancedCoverage

BaseReferenceMap

maps/base-reference-map/{mapType}

This API allows to generate vegetation indice map from the current crop season (InSeason) for a field, based on an image date (using the Coverage API).

This API is based on:

• Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• Image date

This API retrieves:

• URLs to display the InSeason NDVI map in PNG, GEOTIFF, Shapefile and KMZ formats, at 5 m resolution;

• URL to display the map thumbnail file as PNG format;

• URL to display the map legend in only available for PNG format;

• URL to display the world-file in PGW format to locate the map;

• URL to display the Notebook map as PNG format to locate the map on a background Google maps ;

• URL to display the scalebar in PNG format;

• URL to recover The HotSpot points in Shapefile, KMZ and GML formats by zone or by segment;

• The Histogram values by classes;

Authorizations:
oauth2
path Parameters
mapType
required
string
Enum: "INSEASON_NDVI" "INSEASON_EVI" "INSEASON_CVI" "INSEASON_CVIN" "INSEASON_GNDVI" "INSEASONPARTIAL_NDVI" "NDVI" "INSEASON_LAI" "INSEASONPARTIAL_EVI" "INSEASON_S2REP"
query Parameters
thumbnailSize
integer <int32>

Enable to define size of thumbnail image (square shape)

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string
Request Body schema:
object (ImageReference)
offset
number <double>
gain
number <double>
object (SeasonFieldReference)
name
string
tags
Array of strings
object

Responses

Request samples

Content type
{
  • "image": {
    },
  • "offset": 0,
  • "gain": 0,
  • "seasonField": {
    },
  • "name": "string",
  • "tags": [
    ],
  • "externalIds": {
    }
}

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "tags": [
    ],
  • "externalIds": {
    },
  • "seasonField": {
    },
  • "_links": {
    },
  • "index": 0,
  • "hotSpots": [
    ],
  • "legend": {
    },
  • "zones": [
    ],
  • "histogram": {
    },
  • "date": "string",
  • "worldFile": {
    },
  • "mapSize": "string",
  • "bBox": {
    }
}

map-sets/base-reference-map/{mapType}

This API allows to generate vegetation indice map from several season fields for one or several image dates (using the Coverage API).

This API is based on:

• Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• Image date

This API retrieves:

• URLs to display the InSeason NDVI maps in PNG, GEOTIFF, Shapefile and KMZ formats, at 5 m resolution;

• URL to display the map thumbnail file as PNG format;

• URL to display the map legend in only available for PNG format;

• URL to display the world-file in PGW format to locate the map;

• URL to display the Notebook map as PNG format to locate the map on a background Google maps ;

• URL to display the scalebar in PNG format;

• URL to recover The HotSpot points in Shapefile, KMZ and GML formats by zone or by segment;

• The Histogram values by classes;

Authorizations:
oauth2
path Parameters
mapType
required
string
Enum: "INSEASON_NDVI" "INSEASON_EVI" "INSEASON_CVI" "INSEASON_CVIN" "INSEASON_GNDVI" "INSEASONPARTIAL_NDVI" "NDVI" "INSEASON_LAI" "INSEASONPARTIAL_EVI" "INSEASON_S2REP"
query Parameters
directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string
Request Body schema:
imageMimeType
string
Array of objects (BaseReferenceMapBodyParameters)

Responses

Request samples

Content type
{
  • "imageMimeType": "string",
  • "mapParams": [
    ]
}

Response samples

Content type
[
  • {
    }
]

season-fields/{seasonFieldId}/coverage/{imageReference}/base-reference-map/{mapType}

This API allows to request the vegetation indice map from the current crop season (InSeason) for a field, based on an image date and by using shortcuts. (More information about the shortcuts here)

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map type that can be create are :

• INSEASON_NDVI

• INSEASON_EVI

• INSEASON_CVI

• INSEASON_CVIN

• INSEASON_GNDVI

• INSEASONPARTIAL_NDVI and INSEASONPARTIAL_EVI

=> Please see this article for detailed information.

• NDVI

• INSEASON_LAI

This API retrieves:

• URLs to display the InSeason map in PNG, GEOTIFF, Shapefile and KMZ formats, at 5 m resolution;

• URL to display the map thumbnail file as PNG format;

• URL to display the map legend in only available for PNG format;

• URL to display the world-file in PGW format to locate the map;

• URL to display the Notebook map as PNG format to locate the map on a background Google maps ;

• URL to display the scalebar in PNG format;

• URL to recover The HotSpot points in Shapefile, KMZ and GML formats by zone or by segment;

• The Histogram values by classes;

Authorizations:
oauth2
path Parameters
seasonFieldId
required
string

Season field id

imageReference
required
string

Image reference using either the image date or the image id

mapType
required
string
Enum: "INSEASON_NDVI" "INSEASON_EVI" "INSEASON_CVI" "INSEASON_CVIN" "INSEASON_GNDVI" "INSEASONPARTIAL_NDVI" "NDVI" "INSEASON_LAI" "INSEASONPARTIAL_EVI" "INSEASON_S2REP"
query Parameters
thumbnailSize
integer <int32>

Enable to define size of thumbnail image (square shape)

gain
number <double>

This parameter allows to multiply a base reference map value with a constant gain factor. Default value : 1

offset
number <double>

This parameter allows to add a constant offset on the base reference map value. Default value : 0

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "tags": [
    ],
  • "externalIds": {
    },
  • "seasonField": {
    },
  • "_links": {
    },
  • "index": 0,
  • "hotSpots": [
    ],
  • "legend": {
    },
  • "zones": [
    ],
  • "histogram": {
    },
  • "date": "string",
  • "worldFile": {
    },
  • "mapSize": "string",
  • "bBox": {
    }
}

season-fields/{seasonFieldId}/coverage/{imageReference}/base-reference-map/{mapType}/hotspot{extension}

This API allows you to request the file containing hotspots of the vegetation index map by using shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The image date

• The extension

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

the available extensions are:

•.shp.zip

• .klm

• .glm

Authorizations:
oauth2
path Parameters
seasonFieldId
required
string

Season field id

imageReference
required
string

Image reference using either the image date or the image id

mapType
required
string
Enum: "INSEASON_NDVI" "INSEASON_EVI" "INSEASON_CVI" "INSEASON_CVIN" "INSEASON_GNDVI" "INSEASONPARTIAL_NDVI" "NDVI" "INSEASON_LAI" "INSEASONPARTIAL_EVI" "INSEASON_S2REP"
extension
required
string
Enum: ".kml" ".shp.zip" ".gml"
query Parameters
gain
number <double>

This parameter allows to multiply a base reference map value with a constant gain factor. Default value : 1

offset
number <double>

This parameter allows to add a constant offset on the base reference map value. Default value : 0

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/coverage/{imageReference}/base-reference-map/{mapType}/image{extension}

This API allows to request the vegetation indice map by using shortcuts (More information about shortcuts here) :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The image date

• The map Type

• The extension.

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map types are :

• INSEASON_NDVI

• INSEASON_EVI

• INSEASON_CVI

• INSEASON_CVIN

• INSEASON_GNDVI

• INSEASONPARTIAL_NDVI and INSEASONPARTIAL_EVI

=> Please see this article for detailed information.

• NDVI

• INSEASON_LAI

The available extensions are:

• .shp.zip

• .tiff

• .kmz

• .png

Authorizations:
oauth2
path Parameters
seasonFieldId
required
string

Season field id

imageReference
required
string

Image reference using either the image date or the image id

mapType
required
string
Enum: "INSEASON_NDVI" "INSEASON_EVI" "INSEASON_CVI" "INSEASON_CVIN" "INSEASON_GNDVI" "INSEASONPARTIAL_NDVI" "NDVI" "INSEASON_LAI" "INSEASONPARTIAL_EVI" "INSEASON_S2REP"
extension
required
string
Enum: ".png" ".tiff.zip" ".shp.zip" ".kmz"
query Parameters
gain
number <double>

This parameter allows to multiply a base reference map value with a constant gain factor. Default value : 1

offset
number <double>

This parameter allows to add a constant offset on the base reference map value. Default value : 0

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/coverage/{imageReference}/base-reference-map/{mapType}/legend.png

This API allows to request the vegetation indice map legend in PNG format by using Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The image date

• The map Type

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map types are :

• INSEASON_NDVI

• INSEASON_EVI

• INSEASON_CVI

• INSEASON_CVIN

• INSEASON_GNDVI

• INSEASONPARTIAL_NDVI and INSEASONPARTIAL_EVI

=> Please see this article for detailed information.

• NDVI

• INSEASON_LAI

The available extensions are:

• .shp.zip

• .tiff

• .kmz

• .png

Authorizations:
oauth2
path Parameters
seasonFieldId
required
string

Season field id

imageReference
required
string

Image reference using either the image date or the image id

mapType
required
string
Enum: "INSEASON_NDVI" "INSEASON_EVI" "INSEASON_CVI" "INSEASON_CVIN" "INSEASON_GNDVI" "INSEASONPARTIAL_NDVI" "NDVI" "INSEASON_LAI" "INSEASONPARTIAL_EVI" "INSEASON_S2REP"
query Parameters
gain
number <double>

This parameter allows to multiply a base reference map value with a constant gain factor. Default value : 1

offset
number <double>

This parameter allows to add a constant offset on the base reference map value. Default value : 0

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

Responses

season-fields/{seasonFieldId}/coverage/{imageReference}/base-reference-map/{mapType}/notebook.png

This API allows to request the notebook map in png format by using shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The image date

• The map type

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map type are :

• INSEASON_NDVI

• INSEASON_EVI

• INSEASON_CVI

• INSEASON_CVIN

• INSEASON_GNDVI

• INSEASONPARTIAL_NDVI and INSEASONPARTIAL_EVI

=> Please see this article for detailed information.

• NDVI

• INSEASON_LAI

Authorizations:
oauth2
path Parameters
seasonFieldId
required
string

Season field id

imageReference
required
string

Image reference using either the image date or the image id

mapType
required
string
Enum: "INSEASON_NDVI" "INSEASON_EVI" "INSEASON_CVI" "INSEASON_CVIN" "INSEASON_GNDVI" "INSEASONPARTIAL_NDVI" "NDVI" "INSEASON_LAI" "INSEASONPARTIAL_EVI" "INSEASON_S2REP"
query Parameters
gain
number <double>

This parameter allows to multiply a base reference map value with a constant gain factor. Default value : 1

offset
number <double>

This parameter allows to add a constant offset on the base reference map value. Default value : 0

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/coverage/{imageReference}/base-reference-map/{mapType}/scalebar.png

This API allows to request the scalebar map in png format by using shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The image date

• The map type

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map type are :

• INSEASON_NDVI

• INSEASON_EVI

• INSEASON_CVI

• INSEASON_CVIN

• INSEASON_GNDVI

• INSEASONPARTIAL_NDVI and INSEASONPARTIAL_EVI

=> Please see this article for detailed information.

• NDVI

• INSEASON_LAI

Authorizations:
oauth2
path Parameters
seasonFieldId
required
string

Season field id

imageReference
required
string

Image reference using either the image date or the image id

mapType
required
string
Enum: "INSEASON_NDVI" "INSEASON_EVI" "INSEASON_CVI" "INSEASON_CVIN" "INSEASON_GNDVI" "INSEASONPARTIAL_NDVI" "NDVI" "INSEASON_LAI" "INSEASONPARTIAL_EVI" "INSEASON_S2REP"
query Parameters
gain
number <double>

This parameter allows to multiply a base reference map value with a constant gain factor. Default value : 1

offset
number <double>

This parameter allows to add a constant offset on the base reference map value. Default value : 0

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/coverage/{imageReference}/base-reference-map/{mapType}/thumbnail.png

This API allows to request the thumbnail map in png format by using shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The image date

• The map type

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map type are :

• INSEASON_NDVI

• INSEASON_EVI

• INSEASON_CVI

• INSEASON_CVIN

• INSEASON_GNDVI

• INSEASONPARTIAL_NDVI and INSEASONPARTIAL_EVI

=> Please see this article for detailed information.

• NDVI

• INSEASON_LAI

Authorizations:
oauth2
path Parameters
seasonFieldId
required
string

Season field id

imageReference
required
string

Image reference using either the image date or the image id

mapType
required
string
Enum: "INSEASON_NDVI" "INSEASON_EVI" "INSEASON_CVI" "INSEASON_CVIN" "INSEASON_GNDVI" "INSEASONPARTIAL_NDVI" "NDVI" "INSEASON_LAI" "INSEASONPARTIAL_EVI" "INSEASON_S2REP"
query Parameters
thumbnailSize
integer <int32>

Enable to define size of thumbnail image (square shape)

gain
number <double>

This parameter allows to multiply a base reference map value with a constant gain factor. Default value : 1

offset
number <double>

This parameter allows to add a constant offset on the base reference map value. Default value : 0

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/coverage/{imageReference}/base-reference-map/{mapType}/world-file.pgw

This API allows to request the world-file in PGW format to locate the map with shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The image date

• The map type

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map type are :

• INSEASON_NDVI

• INSEASON_EVI

• INSEASON_CVI

• INSEASON_CVIN

• INSEASON_GNDVI

• INSEASONPARTIAL_NDVI and INSEASONPARTIAL_EVI

=> Please see this article for detailed information.

• NDVI

• INSEASON_LAI

Authorizations:
oauth2
path Parameters
seasonFieldId
required
string

Season field id

imageReference
required
string

Image reference using either the image date or the image id

mapType
required
string
Enum: "INSEASON_NDVI" "INSEASON_EVI" "INSEASON_CVI" "INSEASON_CVIN" "INSEASON_GNDVI" "INSEASONPARTIAL_NDVI" "NDVI" "INSEASON_LAI" "INSEASONPARTIAL_EVI" "INSEASON_S2REP"
query Parameters
gain
number <double>

This parameter allows to multiply a base reference map value with a constant gain factor. Default value : 1

offset
number <double>

This parameter allows to add a constant offset on the base reference map value. Default value : 0

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

BaseReferenceMapColorComposition

maps/base-reference-map/COLORCOMPOSITION

This API allows to generate color composition map for a field or a geometry derived satellite image.

This API is based on:

• Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• Map type

This end point can provide different type of result based on the number of band available on the selected image:

• If Blue band is available, it will be a True color composition

• Otherwise it will be a False color composition

Unless other color composition maps are delivered on the bounding box of the field. There is no clipping on field border. This map does not have any legend.

This API retrieves:

• URLs to display the color composition map in PNG, GEOTIFF, SHAPEFILE and KMZ formats, at 5 m resolution;

• URL to display the map thumbnail file as PNG format

• URL to display the map legend in only available for PNG format;

• URL to display the world-file in PGW format to locate the map;

Authorizations:
oauth2
path Parameters
mapType
required
string
Value: "COLORCOMPOSITION"
query Parameters
thumbnailSize
integer <int32>

Enable to define size of thumbnail image (square shape)

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

$epsg-out
integer <int32>

Output geometries projection code

header Parameters
headerParameters
string
Request Body schema:
object (ImageReference)
object (SeasonFieldReference)
name
string
tags
Array of strings
object

Responses

Request samples

Content type
{
  • "image": {
    },
  • "seasonField": {
    },
  • "name": "string",
  • "tags": [
    ],
  • "externalIds": {
    }
}

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "tags": [
    ],
  • "externalIds": {
    },
  • "seasonField": {
    },
  • "_links": {
    },
  • "index": 0,
  • "hotSpots": [
    ],
  • "legend": {
    },
  • "zones": [
    ],
  • "histogram": {
    },
  • "date": "string",
  • "worldFile": {
    },
  • "mapSize": "string",
  • "bBox": {
    }
}

map-sets/base-reference-map/COLORCOMPOSITION

This API allows to generate color composition map set for a set of field

This API is based on:

• Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• Map type

This end point can provide different type of result based on the number of band available on the selected image:

• If Blue band is available, it will be a True color composition

• Otherwise it will be a False color composition

Unless other color composition maps are delivered on the bounding box of the field. There is no clipping on field border. This map does not have any legend.

This API retrieves:

• URLs to display the color composition maps in PNG, GEOTIFF, SHAPEFILE and KMZ formats, at 5 m resolution;

• URL to display the map thumbnail file as PNG format

• URL to display the map legend in only available for PNG format;

• URL to display the world-file in PGW format to locate the map;

Authorizations:
oauth2
path Parameters
mapType
required
string
Value: "COLORCOMPOSITION"
query Parameters
directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

$epsg-out
integer <int32>

Output geometries projection code

header Parameters
headerParameters
string
Request Body schema:
imageMimeType
string
Array of objects (InseasonFlyoverMapBodyParameters)

Responses

Request samples

Content type
{
  • "imageMimeType": "string",
  • "mapParams": [
    ]
}

Response samples

Content type
[
  • {
    }
]

season-fields/{seasonFieldId}/coverage/{imageReference}/base-reference-map/COLORCOMPOSITION

This API allows to request the color composition map by using shortcuts. (More information about shortcuts here) :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The image date

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

This API retrieves:

• URLs to display the color composition map in PNG;

• URL to display the map thumbnail file as PNG format;

• URL to display the world-file in PGW format to locate the map;

Authorizations:
oauth2
path Parameters
imageReference
required
string

Image reference using either the image date or the image id

mapType
required
string
Value: "COLORCOMPOSITION"
seasonFieldId
required
string

Season field id

query Parameters
thumbnailSize
integer <int32>

Enable to define size of thumbnail image (square shape)

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

$epsg-out
integer <int32>

Output geometries projection code

header Parameters
headerParameters
string

Responses

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "tags": [
    ],
  • "externalIds": {
    },
  • "seasonField": {
    },
  • "_links": {
    },
  • "index": 0,
  • "hotSpots": [
    ],
  • "legend": {
    },
  • "zones": [
    ],
  • "histogram": {
    },
  • "date": "string",
  • "worldFile": {
    },
  • "mapSize": "string",
  • "bBox": {
    }
}

season-fields/{seasonFieldId}/coverage/{imageReference}/base-reference-map/COLORCOMPOSITION/image.png

This API allows to request the color composition map in PNG format with shortcuts) :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The image date

• The map Type

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map type is :

• COLORCOMPOSITION

Authorizations:
oauth2
path Parameters
imageReference
required
string

Image reference using either the image date or the image id

mapType
required
string
Value: "COLORCOMPOSITION"
seasonFieldId
required
string

Season field id

query Parameters
directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

$epsg-out
integer <int32>

Output geometries projection code

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/coverage/{imageReference}/base-reference-map/COLORCOMPOSITION/thumbnail.png

This API allows to request the thumbnail file of the color composition map as PNG format with shortcuts) :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The image date

• The map Type

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map type is :

• COLORCOMPOSITION

Authorizations:
oauth2
path Parameters
imageReference
required
string

Image reference using either the image date or the image id

mapType
required
string
Value: "COLORCOMPOSITION"
seasonFieldId
required
string

Season field id

query Parameters
thumbnailSize
integer <int32>

Enable to define size of thumbnail image (square shape)

$epsg-out
integer <int32>

Output geometries projection code

Responses

season-fields/{seasonFieldId}/coverage/{imageReference}/base-reference-map/COLORCOMPOSITION/world-file.pgw

This API allows to request the world-file in PGW format to locate the Color composition map with shortcuts) :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The image date

• The map Type

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map type is :

• COLORCOMPOSITION

Authorizations:
oauth2
path Parameters
imageReference
required
string

Image reference using either the image date or the image id

mapType
required
string
Value: "COLORCOMPOSITION"
seasonFieldId
required
string

Season field id

query Parameters
directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

$epsg-out
integer <int32>

Output geometries projection code

header Parameters
headerParameters
string

Responses

CanopyMap

maps/canopy-map/{mapType}

This model uses biomass for creating a map of preconisation values per pixels in (kg of N)/ha.

This API allows to display a LAI map from the current crop season for a field, based on an image date (using the Coverage API) and for the N parameters and a target LAI.

This type of map can only be used with specifics Crop ID like "WINTER_WHEAT_1"

This API is based on:

• Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• Image dates

• N parameters

• LAI target

• GrowthStage code

This API retrieves:

• URLs to display The canopy map in PNG, GEOTIFF, Shapefile and KMZ formats, at 5 m resolution;

• URL to display The thumbnail file as PNG format;

• URL to display The legend in only available for PNG format;

• URL to display the world-file in PGW format to locate the map;

• URL to display the Notebook map as PNG format to locate the map on a background Google maps ;

• URL to display the scalebar in PNG format;

• URL to recover The HotSpot points in Shapefile, KMZ and GML formats by zone or by segment;

• The Histogram values by classes;

Authorizations:
oauth2
path Parameters
mapType
required
string
Enum: "INSEASONCANOPY_MODEL_1_LAI" "INSEASONCANOPY_MODEL_3_LAI"
query Parameters
thumbnailSize
integer <int32>

Enable to define size of thumbnail image (square shape)

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string
Request Body schema:
object (ImageReference)
nPlanned
number <float>
nMin
number <float>
nMax
number <float>
object (GrowthStage)
object (SeasonFieldReference)
name
string
tags
Array of strings
object

Responses

Request samples

Content type
{
  • "image": {
    },
  • "nPlanned": 0,
  • "nMin": 0,
  • "nMax": 0,
  • "growthStage": {
    },
  • "seasonField": {
    },
  • "name": "string",
  • "tags": [
    ],
  • "externalIds": {
    }
}

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "tags": [
    ],
  • "externalIds": {
    },
  • "seasonField": {
    },
  • "_links": {
    },
  • "index": 0,
  • "hotSpots": [
    ],
  • "legend": {
    },
  • "zones": [
    ],
  • "histogram": {
    },
  • "date": "string",
  • "worldFile": {
    },
  • "mapSize": "string",
  • "bBox": {
    }
}

map-sets/canopy-map/{mapType}

This model uses biomass for creating a map of preconisation values per pixels in (kg of N)/ha.

This API allows to display a LAI map from the current crop season for several fields and or images dates (using the Coverage API) and for the N parameters and a target LAI.

This type of map can only be used with specifics Crop ID like "WINTER_WHEAT_1"

This API is based on:

• Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• Image dates

• N parameters

• LAI target

• GrowthStage code

This API retrieves:

• URLs to display The canopy maps in PNG, GEOTIFF, Shapefile and KMZ formats, at 5 m resolution;

• URL to display The thumbnail file as PNG format;

• URL to display The legend in only available for PNG format;

• URL to display the world-file in PGW format to locate the map;

• URL to display the Notebook map as PNG format to locate the map on a background Google maps ;

• URL to display the scalebar in PNG format;

• URL to recover The HotSpot points in Shapefile, KMZ and GML formats by zone or by segment;

• The Histogram values by classes;

Authorizations:
oauth2
path Parameters
mapType
required
string
Enum: "INSEASONCANOPY_MODEL_1_LAI" "INSEASONCANOPY_MODEL_3_LAI"
query Parameters
directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string
Request Body schema:
imageMimeType
string
Array of objects (CanopyMapBodyParameters)

Responses

Request samples

Content type
{
  • "imageMimeType": "string",
  • "mapParams": [
    ]
}

Response samples

Content type
[
  • {
    }
]

season-fields/{seasonFieldId}/coverage/{imageReference}/canopy-map/{mapType}/n-planned/{nPlanned}/growth-stage/{growthStage.code}

This API allows to request the canopy map by using shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The image date

• The map Type

• The n planned value

• The growth stage code

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map types are :

• INSEASONCANOPY_MODEL_1_LAI

• INSEASONCANOPY_MODEL_3_LAI

Authorizations:
oauth2
path Parameters
imageReference
required
string

Image reference using either the image date or the image id

nPlanned
required
number <float>

Dose of Nitrogen planned units depend on User profile. UK: kg / ha

growthStage.Code
required
string
mapType
required
string
Enum: "INSEASONCANOPY_MODEL_1_LAI" "INSEASONCANOPY_MODEL_3_LAI"
seasonFieldId
required
string

Season field id

query Parameters
thumbnailSize
integer <int32>

Enable to define size of thumbnail image (square shape)

nMax
number <float>

Maximum threshold for the N dose Minimum value allowed is 0. Maximum value allowed is 999.

nMin
number <float>

Minimum threshold for the N dose Minimum value allowed is 0. Maximum value allowed is 999.

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "tags": [
    ],
  • "externalIds": {
    },
  • "seasonField": {
    },
  • "_links": {
    },
  • "index": 0,
  • "hotSpots": [
    ],
  • "legend": {
    },
  • "zones": [
    ],
  • "histogram": {
    },
  • "date": "string",
  • "worldFile": {
    },
  • "mapSize": "string",
  • "bBox": {
    }
}

season-fields/{seasonFieldId}/coverage/{imageReference}/canopy-map/{mapType}/n-planned/{nPlanned}/growth-stage/{growthStage.code}/hotspot{extension}

This API allows you to request the file containing hotspots of the canopy map by using shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The image date

• The extension

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

the available extensions are:

•.shp.zip

• .klm

• .glm

Authorizations:
oauth2
path Parameters
imageReference
required
string

Image reference using either the image date or the image id

nPlanned
required
number <float>

Dose of Nitrogen planned units depend on User profile. UK: kg / ha

growthStage.Code
required
string
mapType
required
string
Enum: "INSEASONCANOPY_MODEL_1_LAI" "INSEASONCANOPY_MODEL_3_LAI"
seasonFieldId
required
string

Season field id

extension
required
string
Enum: ".kml" ".shp.zip" ".gml"
query Parameters
nMax
number <float>

Maximum threshold for the N dose Minimum value allowed is 0. Maximum value allowed is 999.

nMin
number <float>

Minimum threshold for the N dose Minimum value allowed is 0. Maximum value allowed is 999.

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/coverage/{imageReference}/canopy-map/{mapType}/n-planned/{nPlanned}/growth-stage/{growthStage.code}/image{extension}

This API allows to request the canopy map with shortcuts) :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The image date

• The map Type

• The n planned value

• The growth stage code

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map types are :

• INSEASONCANOPY_MODEL_1_LAI

• INSEASONCANOPY_MODEL_3_LAI

The available extensions are:

• .shp.zip

• .tiff

• .kmz

• .png

Authorizations:
oauth2
path Parameters
imageReference
required
string

Image reference using either the image date or the image id

nPlanned
required
number <float>

Dose of Nitrogen planned units depend on User profile. UK: kg / ha

growthStage.Code
required
string
mapType
required
string
Enum: "INSEASONCANOPY_MODEL_1_LAI" "INSEASONCANOPY_MODEL_3_LAI"
seasonFieldId
required
string

Season field id

extension
required
string
Enum: ".png" ".tiff.zip" ".shp.zip" ".kmz"
query Parameters
nMax
number <float>

Maximum threshold for the N dose Minimum value allowed is 0. Maximum value allowed is 999.

nMin
number <float>

Minimum threshold for the N dose Minimum value allowed is 0. Maximum value allowed is 999.

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/coverage/{imageReference}/canopy-map/{mapType}/n-planned/{nPlanned}/growth-stage/{growthStage.code}/legend.png

This API allows to request the canopy map legend in PNG format by using Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The image date

• The map Type

• The n planned value

• The growth stage code

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map types are :

• INSEASONCANOPY_MODEL_1_LAI

• INSEASONCANOPY_MODEL_3_LAI

Authorizations:
oauth2
path Parameters
imageReference
required
string

Image reference using either the image date or the image id

nPlanned
required
number <float>

Dose of Nitrogen planned units depend on User profile. UK: kg / ha

growthStage.Code
required
string
mapType
required
string
Enum: "INSEASONCANOPY_MODEL_1_LAI" "INSEASONCANOPY_MODEL_3_LAI"
seasonFieldId
required
string

Season field id

query Parameters
nMax
number <float>

Maximum threshold for the N dose Minimum value allowed is 0. Maximum value allowed is 999.

nMin
number <float>

Minimum threshold for the N dose Minimum value allowed is 0. Maximum value allowed is 999.

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

Responses

season-fields/{seasonFieldId}/coverage/{imageReference}/canopy-map/{mapType}/n-planned/{nPlanned}/growth-stage/{growthStage.code}/notebook.png

This API allows to request the canopy map notebook in PNG format by using Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The image date

• The map Type

• The n planned value

• The growth stage code

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map types are :

• INSEASONCANOPY_MODEL_1_LAI

• INSEASONCANOPY_MODEL_3_LAI

Authorizations:
oauth2
path Parameters
imageReference
required
string

Image reference using either the image date or the image id

nPlanned
required
number <float>

Dose of Nitrogen planned units depend on User profile. UK: kg / ha

growthStage.Code
required
string
mapType
required
string
Enum: "INSEASONCANOPY_MODEL_1_LAI" "INSEASONCANOPY_MODEL_3_LAI"
seasonFieldId
required
string

Season field id

query Parameters
nMax
number <float>

Maximum threshold for the N dose Minimum value allowed is 0. Maximum value allowed is 999.

nMin
number <float>

Minimum threshold for the N dose Minimum value allowed is 0. Maximum value allowed is 999.

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/coverage/{imageReference}/canopy-map/{mapType}/n-planned/{nPlanned}/growth-stage/{growthStage.code}/scalebar.png

This API allows to request the canopy map scalebar in PNG format by using Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The image date

• The map Type

• The n planned value

• The growth stage code

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map types are :

• INSEASONCANOPY_MODEL_1_LAI

• INSEASONCANOPY_MODEL_3_LAI

Authorizations:
oauth2
path Parameters
imageReference
required
string

Image reference using either the image date or the image id

nPlanned
required
number <float>

Dose of Nitrogen planned units depend on User profile. UK: kg / ha

growthStage.Code
required
string
mapType
required
string
Enum: "INSEASONCANOPY_MODEL_1_LAI" "INSEASONCANOPY_MODEL_3_LAI"
seasonFieldId
required
string

Season field id

query Parameters
nMax
number <float>

Maximum threshold for the N dose Minimum value allowed is 0. Maximum value allowed is 999.

nMin
number <float>

Minimum threshold for the N dose Minimum value allowed is 0. Maximum value allowed is 999.

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/coverage/{imageReference}/canopy-map/{mapType}/n-planned/{nPlanned}/growth-stage/{growthStage.code}/thumbnail.png

This API allows to request the canopy map thumbnail in PNG format by using Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The image date

• The map Type

• The n planned value

• The growth stage code

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map types are :

• INSEASONCANOPY_MODEL_1_LAI

• INSEASONCANOPY_MODEL_3_LAI

Authorizations:
oauth2
path Parameters
imageReference
required
string

Image reference using either the image date or the image id

nPlanned
required
number <float>

Dose of Nitrogen planned units depend on User profile. UK: kg / ha

growthStage.Code
required
string
mapType
required
string
Enum: "INSEASONCANOPY_MODEL_1_LAI" "INSEASONCANOPY_MODEL_3_LAI"
seasonFieldId
required
string

Season field id

query Parameters
thumbnailSize
integer <int32>

Enable to define size of thumbnail image (square shape)

nMax
number <float>

Maximum threshold for the N dose Minimum value allowed is 0. Maximum value allowed is 999.

nMin
number <float>

Minimum threshold for the N dose Minimum value allowed is 0. Maximum value allowed is 999.

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/coverage/{imageReference}/canopy-map/{mapType}/n-planned/{nPlanned}/growth-stage/{growthStage.code}/world-file.pgw

This API allows to request the world-file in PGW format to locate the Canopy map with Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The image date

• The map Type

• The n planned value

• The growth stage code

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map types are :

• INSEASONCANOPY_MODEL_1_LAI

• INSEASONCANOPY_MODEL_3_LAI

Authorizations:
oauth2
path Parameters
imageReference
required
string

Image reference using either the image date or the image id

nPlanned
required
number <float>

Dose of Nitrogen planned units depend on User profile. UK: kg / ha

growthStage.Code
required
string
mapType
required
string
Enum: "INSEASONCANOPY_MODEL_1_LAI" "INSEASONCANOPY_MODEL_3_LAI"
seasonFieldId
required
string

Season field id

query Parameters
nMax
number <float>

Maximum threshold for the N dose Minimum value allowed is 0. Maximum value allowed is 999.

nMin
number <float>

Minimum threshold for the N dose Minimum value allowed is 0. Maximum value allowed is 999.

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

CanopyOsrMap

maps/canopy-osr-map/{mapType}

This model uses LAI for creating a map of preconisation values per pixels in (kg of N)/ha.

This API allows to display a LAI map from the current crop season for a field, based on an image date (using the Coverage API) and for the N parameters and a target LAI.

Canopy OSR 1: a target LAI is defined by field depending on the growth stage. If the crop is behind target, it gets more N. (for oilseed rape)

This API is based on:

• Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• Image dates

• N parameters

• Yield objective

• % of total dose to apply

This API retrieves:

• URLs to display The canopy OSR map in PNG, GEOTIFF, Shapefile and KMZ formats, at 5 m resolution;

• URL to display The thumbnail file as PNG format;

• URL to display The legend in only available for PNG format;

• URL to display the world-file in PGW format to locate the map;

• URL to display the Notebook map as PNG format to locate the map on a background Google maps ;

• URL to display the scalebar in PNG format;

• URL to recover The HotSpot points in Shapefile, KMZ and GML formats by zone or by segment;

• The Histogram values by classes;

Authorizations:
oauth2
path Parameters
mapType
required
string
Value: "INSEASONCANOPY_MODEL_OSR1_LAI"
query Parameters
thumbnailSize
integer <int32>

Enable to define size of thumbnail image (square shape)

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string
Request Body schema:
object (ImageReference)
nMin
number <float>
naturallyPresentNDose
number <float>
nMax
number <float>
yieldObjective
number <float>
percentOfTotal
number <float>
object (SeasonFieldReference)
name
string
tags
Array of strings
object

Responses

Request samples

Content type
{
  • "image": {
    },
  • "nMin": 0,
  • "naturallyPresentNDose": 0,
  • "nMax": 0,
  • "yieldObjective": 0,
  • "percentOfTotal": 0,
  • "seasonField": {
    },
  • "name": "string",
  • "tags": [
    ],
  • "externalIds": {
    }
}

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "tags": [
    ],
  • "externalIds": {
    },
  • "seasonField": {
    },
  • "_links": {
    },
  • "index": 0,
  • "hotSpots": [
    ],
  • "legend": {
    },
  • "zones": [
    ],
  • "histogram": {
    },
  • "date": "string",
  • "worldFile": {
    },
  • "mapSize": "string",
  • "bBox": {
    }
}

map-sets/canopy-osr-map/{mapType}

This model uses LAI for creating a map of preconisation values per pixels in (kg of N)/ha.

This API allows to display a set of several LAI maps from the current crop season for several fields and or images dates (using the Coverage API) and for the N parameters and a target LAI.

Canopy OSR 1: a target LAI is defined by field depending on the growth stage. If the crop is behind target, it gets more N. (for oilseed rape)

This API is based on:

• Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• Image dates

• N parameters

• Yield objective

• % of total dose to apply

This API retrieves:

• URLs to display The canopy OSR maps in PNG, GEOTIFF, Shapefile and KMZ formats, at 5 m resolution;

• URL to display The thumbnail file as PNG format;

• URL to display The legend in only available for PNG format;

• URL to display the world-file in PGW format to locate the map;

• URL to display the Notebook map as PNG format to locate the map on a background Google maps ;

• URL to display the scalebar in PNG format;

• URL to recover The HotSpot points in Shapefile, KMZ and GML formats by zone or by segment;

• The Histogram values by classes;

Authorizations:
oauth2
path Parameters
mapType
required
string
Value: "INSEASONCANOPY_MODEL_OSR1_LAI"
query Parameters
directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string
Request Body schema:
imageMimeType
string
Array of objects (CanopyOsrMapBodyParameters)

Responses

Request samples

Content type
{
  • "imageMimeType": "string",
  • "mapParams": [
    ]
}

Response samples

Content type
[
  • {
    }
]

season-fields/{seasonFieldId}/coverage/{imageReference}/canopy-osr-map/{mapType}/naturally-present-n-dose/{naturallyPresentNDose}/yield-objective/{yieldObjective}

This API allows to request canopy OSR map by using shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The image date

• The map Type

• The naturally present N Dose

• The Yield objective

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map type is :

• INSEASONCANOPY_MODEL_OSR1_LAI

Authorizations:
oauth2
path Parameters
imageReference
required
string

Image reference using either the image date or the image id

naturallyPresentNDose
required
number <float>
yieldObjective
required
number <float>
mapType
required
string
Value: "INSEASONCANOPY_MODEL_OSR1_LAI"
seasonFieldId
required
string

Season field id

query Parameters
percentOfTotal
number <float>
thumbnailSize
integer <int32>

Enable to define size of thumbnail image (square shape)

nMax
number <float>

Maximum threshold for the N dose Minimum value allowed is 0. Maximum value allowed is 999.

nMin
number <float>

Minimum threshold for the N dose Minimum value allowed is 0. Maximum value allowed is 999.

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "tags": [
    ],
  • "externalIds": {
    },
  • "seasonField": {
    },
  • "_links": {
    },
  • "index": 0,
  • "hotSpots": [
    ],
  • "legend": {
    },
  • "zones": [
    ],
  • "histogram": {
    },
  • "date": "string",
  • "worldFile": {
    },
  • "mapSize": "string",
  • "bBox": {
    }
}

season-fields/{seasonFieldId}/coverage/{imageReference}/canopy-osr-map/{mapType}/naturally-present-n-dose/{naturallyPresentNDose}/yield-objective/{yieldObjective}/hotspot{extension}

This API allows you to request the file containing hotspots of the canopy osr map by using shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The image date

• The map Type

• The naturally present N Dose

• The Yield objective

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map type is :

• INSEASONCANOPY_MODEL_OSR1_LAI

Authorizations:
oauth2
path Parameters
imageReference
required
string

Image reference using either the image date or the image id

naturallyPresentNDose
required
number <float>
yieldObjective
required
number <float>
mapType
required
string
Value: "INSEASONCANOPY_MODEL_OSR1_LAI"
seasonFieldId
required
string

Season field id

extension
required
string
Enum: ".kml" ".shp.zip" ".gml"
query Parameters
percentOfTotal
number <float>
nMax
number <float>

Maximum threshold for the N dose Minimum value allowed is 0. Maximum value allowed is 999.

nMin
number <float>

Minimum threshold for the N dose Minimum value allowed is 0. Maximum value allowed is 999.

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/coverage/{imageReference}/canopy-osr-map/{mapType}/naturally-present-n-dose/{naturallyPresentNDose}/yield-objective/{yieldObjective}/image{extension}

This API allows to request the canopy OSR image by using Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The image date

• The map Type

• The naturally present N Dose

• The Yield objective

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map type is :

• INSEASONCANOPY_MODEL_OSR1_LAI

The available extensions are:

• .shp.zip

• .tiff

• .kmz

• .png

Authorizations:
oauth2
path Parameters
imageReference
required
string

Image reference using either the image date or the image id

naturallyPresentNDose
required
number <float>
yieldObjective
required
number <float>
mapType
required
string
Value: "INSEASONCANOPY_MODEL_OSR1_LAI"
seasonFieldId
required
string

Season field id

extension
required
string
Enum: ".png" ".tiff.zip" ".shp.zip" ".kmz"
query Parameters
percentOfTotal
number <float>
nMax
number <float>

Maximum threshold for the N dose Minimum value allowed is 0. Maximum value allowed is 999.

nMin
number <float>

Minimum threshold for the N dose Minimum value allowed is 0. Maximum value allowed is 999.

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/coverage/{imageReference}/canopy-osr-map/{mapType}/naturally-present-n-dose/{naturallyPresentNDose}/yield-objective/{yieldObjective}/legend.png

Authorizations:
oauth2
path Parameters
imageReference
required
string

Image reference using either the image date or the image id

naturallyPresentNDose
required
number <float>
yieldObjective
required
number <float>
mapType
required
string
Value: "INSEASONCANOPY_MODEL_OSR1_LAI"
seasonFieldId
required
string

Season field id

query Parameters
percentOfTotal
number <float>
nMax
number <float>

Maximum threshold for the N dose Minimum value allowed is 0. Maximum value allowed is 999.

nMin
number <float>

Minimum threshold for the N dose Minimum value allowed is 0. Maximum value allowed is 999.

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

Responses

season-fields/{seasonFieldId}/coverage/{imageReference}/canopy-osr-map/{mapType}/naturally-present-n-dose/{naturallyPresentNDose}/yield-objective/{yieldObjective}/notebook.png

This API allows to request the canopy OSR notebook in PNG format by using Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The image date

• The map Type

• The naturally present N Dose

• The Yield objective

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map type is :

• INSEASONCANOPY_MODEL_OSR1_LAI

Authorizations:
oauth2
path Parameters
imageReference
required
string

Image reference using either the image date or the image id

naturallyPresentNDose
required
number <float>
yieldObjective
required
number <float>
mapType
required
string
Value: "INSEASONCANOPY_MODEL_OSR1_LAI"
seasonFieldId
required
string

Season field id

query Parameters
percentOfTotal
number <float>
nMax
number <float>

Maximum threshold for the N dose Minimum value allowed is 0. Maximum value allowed is 999.

nMin
number <float>

Minimum threshold for the N dose Minimum value allowed is 0. Maximum value allowed is 999.

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/coverage/{imageReference}/canopy-osr-map/{mapType}/naturally-present-n-dose/{naturallyPresentNDose}/yield-objective/{yieldObjective}/scalebar.png

This API allows to request the canopy OSR Scalebar in PNG format by using Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The image date

• The map Type

• The naturally present N Dose

• The Yield objective

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map type is :

• INSEASONCANOPY_MODEL_OSR1_LAI

Authorizations:
oauth2
path Parameters
imageReference
required
string

Image reference using either the image date or the image id

naturallyPresentNDose
required
number <float>
yieldObjective
required
number <float>
mapType
required
string
Value: "INSEASONCANOPY_MODEL_OSR1_LAI"
seasonFieldId
required
string

Season field id

query Parameters
percentOfTotal
number <float>
nMax
number <float>

Maximum threshold for the N dose Minimum value allowed is 0. Maximum value allowed is 999.

nMin
number <float>

Minimum threshold for the N dose Minimum value allowed is 0. Maximum value allowed is 999.

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/coverage/{imageReference}/canopy-osr-map/{mapType}/naturally-present-n-dose/{naturallyPresentNDose}/yield-objective/{yieldObjective}/thumbnail.png

This API allows to request the canopy OSR thumbnail in PNG format by using Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The image date

• The map Type

• The naturally present N Dose

• The Yield objective

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map type is :

• INSEASONCANOPY_MODEL_OSR1_LAI

Authorizations:
oauth2
path Parameters
imageReference
required
string

Image reference using either the image date or the image id

naturallyPresentNDose
required
number <float>
yieldObjective
required
number <float>
mapType
required
string
Value: "INSEASONCANOPY_MODEL_OSR1_LAI"
seasonFieldId
required
string

Season field id

query Parameters
percentOfTotal
number <float>
thumbnailSize
integer <int32>

Enable to define size of thumbnail image (square shape)

nMax
number <float>

Maximum threshold for the N dose Minimum value allowed is 0. Maximum value allowed is 999.

nMin
number <float>

Minimum threshold for the N dose Minimum value allowed is 0. Maximum value allowed is 999.

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/coverage/{imageReference}/canopy-osr-map/{mapType}/naturally-present-n-dose/{naturallyPresentNDose}/yield-objective/{yieldObjective}/world-file.pgw

This API allows to request the world-file in PGW format to locate the canopy OSR map with Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The image date

• The map Type

• The naturally present N Dose

• The Yield objective

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map type is :

• INSEASONCANOPY_MODEL_OSR1_LAI

Authorizations:
oauth2
path Parameters
imageReference
required
string

Image reference using either the image date or the image id

naturallyPresentNDose
required
number <float>
yieldObjective
required
number <float>
mapType
required
string
Value: "INSEASONCANOPY_MODEL_OSR1_LAI"
seasonFieldId
required
string

Season field id

query Parameters
percentOfTotal
number <float>
nMax
number <float>

Maximum threshold for the N dose Minimum value allowed is 0. Maximum value allowed is 999.

nMin
number <float>

Minimum threshold for the N dose Minimum value allowed is 0. Maximum value allowed is 999.

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

CatalogImagery

season-fields/{seasonFieldId}/catalog-imagery

This APIs allow to display catalog imagery for a specific season field identifiers (Geosys Season Field ID).

This API retrieves a catalog with the following data:

• Available cloud-free imagery dates for the queried field. By default it will return only for the last 6 months;

• The image id;

• The spatial Resolution;

• The Zenith Angle (In degree);

• The Available Bands;

• the Sensor type;

• the Weather type (see The API coverage for more details);

• Soil material: metadata describing if this is a vegetation image or a bare soil image (see the Coverage APIs for more details);

• Image date;

The map types that can be create are :

• INSEASON_NDVI

• INSEASON_EVI

• INSEASON_CVI

• INSEASON_GNDVI

• INSEASONPARTIAL_NDVI and INSEASONPARTIAL_EVI

=> Please see this article for detailed information.

• INSEASON_LAI

• INSEASONFIELD_AVERAGE_REVERSE_NDVI

• INSEASONFIELD_AVERAGE_NDVI

• OM

• YGM

• YPM

• COLORCOMPOSITION

This API retrieves:

• URLs to display ** the Catalog imagery maps** in PNG, GEOTIFF, Shapefile and KMZ formats, at 5m resolution;

• URL to display the map thumbnail file as PNG format;

• URL to display the map legend in only available for PNG format;

• URL to display the world-file in PGW format to locate the map;

• URL to display the Notebook map as PNG format to locate the map on a background Google maps;

• URL to display the scalebar in PNG format;

the API display an imagery catalog with specific information in case of partial imagery

• Available geometry issue imagery date for the queried field Inseason partial.

• Available no-data imagery date for the queried field Inseason partial.

• Available radiometry issue imagery date for the queried field Inseason partial.

Authorizations:
oauth2
path Parameters
seasonFieldId
required
string

Filter

query Parameters
$sort
string

Ordered comma separated list of fields to sort on

$filter
string

Filter expression

$fields
string

Comma separated list of fields to retrieve

$group-by
string

Ordered comma separated list of fields to group by

$page-groups
string

Ordered comma separated list of fields to group items on pages by

$column-groups
string

Ordered comma separated list of fields to group columns by

$row-groups
string

Ordered comma separated list of fields to group rows by

$offset
integer <int32>
Default: 0

Offset in the list to get the first item from

$limit
string
Default: "20"

Maximum number of items to return

$count
boolean
Default: false

Returns number of items with the given filter as header

$offset-including
string

Calculates $offset automatically to show given item

$format-settings
string

Input and output format settings

$epsg
string

Input and output geometries projection code

$epsg-in
string

Input geometries projection code

$epsg-out
string

Output geometries projection code

Image.Date
string

Filters search by image date

Image.Sensor
string

Filter by sensor type (SENTINEL_2|DEIMOS_1|ALSAT_1B|RESOURCESAT2|LANDSAT_8|CBERS_4|KAZSTSAT|GAOPFEN)

Image.Weather
string

Filter by weather type (HOT|COLD|WET|DRY)

Image.SoilMaterial
string

Filter by soil material type (BARE|VEGETATION)

Image.IsRecalibrated
boolean

Values: True or False. Value by default: False. Allows to display the re calibrated images or not.

Maps.Type
string

Filter by map type

CoverageType
string

Filter by coverage type (CLEAR|CLOUD|BORDER|NO_DATA|GEOMETRY_ISSUE|RADIOMETRY_ISSUE)

Responses

Response samples

Content type
[
  • {
    }
]

season-fields/{seasonFieldId}/catalog-imagery

Authorizations:
oauth2
path Parameters
seasonFieldId
required
string

Filter

query Parameters
$sort
string

Ordered comma separated list of fields to sort on

$filter
string

Filter expression

$fields
string

Comma separated list of fields to retrieve

$group-by
string

Ordered comma separated list of fields to group by

$page-groups
string

Ordered comma separated list of fields to group items on pages by

$column-groups
string

Ordered comma separated list of fields to group columns by

$row-groups
string

Ordered comma separated list of fields to group rows by

$offset
integer <int32>
Default: 0

Offset in the list to get the first item from

$limit
string
Default: "20"

Maximum number of items to return

$count
boolean
Default: true

Returns number of items with the given filter as header

$index-of
string

Returns index of given item in the list as header

$epsg
string

Input and output geometries projection code

$epsg-in
string

Input geometries projection code

$epsg-out
string

Output geometries projection code

Image.Date
string

Filters search by image date

Image.Sensor
string

Filter by sensor type (SENTINEL_2|DEIMOS_1|ALSAT_1B|RESOURCESAT2|LANDSAT_8|CBERS_4|KAZSTSAT|GAOPFEN)

Image.Weather
string

Filter by weather type (HOT|COLD|WET|DRY)

Image.SoilMaterial
string

Filter by soil material type (BARE|VEGETATION)

Image.IsRecalibrated
boolean

Values: True or False. Value by default: False. Allows to display the re calibrated images or not.

Maps.Type
string

Filter by map type

CoverageType
string

Filter by coverage type (CLEAR|CLOUD|BORDER|NO_DATA|GEOMETRY_ISSUE|RADIOMETRY_ISSUE)

Responses

Response samples

Content type
[
  • {
    }
]

season-fields/catalog-imagery

This APIs allow to display catalog imagery.

This API retrieves a catalog with the following data:

• Available cloud-free imagery dates for the queried field. By default it will return only for the last 6 months;

• The image id;

• The spatial Resolution;

• The Zenith Angle (In degree);

• The Available Bands;

• the Sensor type;

• the Weather type (see The API coverage for more details);

• Soil material: metadata describing if this is a vegetation image or a bare soil image (see the Coverage APIs for more details);

• Image date;

The map types that can be create are :

• INSEASON_NDVI

• INSEASON_EVI

• INSEASON_CVI

• INSEASON_GNDVI

• INSEASONPARTIAL_NDVI and INSEASONPARTIAL_EVI

=> Please see this article for detailed information.

• INSEASON_LAI

• INSEASONFIELD_AVERAGE_REVERSE_NDVI

• INSEASONFIELD_AVERAGE_NDVI

• OM

• YGM

• YPM

• COLORCOMPOSITION

This API retrieves:

• URLs to display ** the Catalog imagery maps** in PNG, GEOTIFF, Shapefile and KMZ formats, at 5 m resolution;

• URL to display the map thumbnail file as PNG format;

• URL to display the map legend in only available for PNG format;

• URL to display the world-file in PGW format to locate the map;

• URL to display the Notebook map as PNG format to locate the map on a background Google maps;

• URL to display the scalebar in PNG format;

the API display an imagery catalog with specific information in case of partial imagery

• Available geometry issue imagery date for the queried field Inseason partial.

• Available no-data imagery date for the queried field Inseason partial.

• Available radiometry issue imagery date for the queried field Inseason partial.

Authorizations:
oauth2
query Parameters
$sort
string

Ordered comma separated list of fields to sort on

$filter
string

Filter expression

$fields
string

Comma separated list of fields to retrieve

$group-by
string

Ordered comma separated list of fields to group by

$page-groups
string

Ordered comma separated list of fields to group items on pages by

$column-groups
string

Ordered comma separated list of fields to group columns by

$row-groups
string

Ordered comma separated list of fields to group rows by

$offset
integer <int32>
Default: 0

Offset in the list to get the first item from

$limit
string
Default: "20"

Maximum number of items to return

$count
boolean
Default: false

Returns number of items with the given filter as header

$offset-including
string

Calculates $offset automatically to show given item

$format-settings
string

Input and output format settings

$epsg
string

Input and output geometries projection code

$epsg-in
string

Input geometries projection code

$epsg-out
string

Output geometries projection code

SeasonField.Id
string
SeasonField.CustomerExternalId
string
Image.Date
string

Filters search by image date

Image.Sensor
string

Filter by sensor type (SENTINEL_2|DEIMOS_1|ALSAT_1B|RESOURCESAT2|LANDSAT_8|CBERS_4|KAZSTSAT|GAOPFEN)

Image.Weather
string

Filter by weather type (HOT|COLD|WET|DRY)

Image.SoilMaterial
string

Filter by soil material type (BARE|VEGETATION)

Image.IsRecalibrated
boolean

Values: True or False. Value by default: False. Allows to display the re calibrated images or not.

Maps.Type
string

Filter by map type

CoverageType
string

Filter by coverage type (CLEAR|CLOUD|BORDER|NO_DATA|GEOMETRY_ISSUE|RADIOMETRY_ISSUE)

Responses

Response samples

Content type
[
  • {
    }
]

Coverage

season-fields/{seasonFieldId}/coverage

This APIs allow to display coverage for a specific season field identifiers (Geosys Season Field ID).

This API retrieves a catalog with the following data:

• Available cloud-free imagery dates for the queried field. By default it will return only for the last 6 months.

• The image id

• Sensor

• Soil material: metadata describing if this is a vegetation image or a bare soil image (in text format);

• Weather type: Metadata describing the weather conditions (in text format). The weather type is a metadata that describes the weather conditions at the acquisition date of the image.

The weather type is linked to the image type (Vegetation or Bare soil) and can be defined as follows :

Image Type Weather type Weather type definition
Bare soil Cold The seasonal weather at the image acquisition had been colder than the 30-years average
Bare soil Hot The seasonal weather at the image acquisition had been warmer than the 30-years average 
                                                                                                                                                                                                    |Vegetation | Wet |The seasonal weather at the image acquisition had been **wetter than the 30-years average**
                                                                                                                                                                                                    |Vegetation | Dry |The seasonal weather at the image acquisition had been **dryer than the 30-years average**\.

The map types that can be create are :

• INSEASON_NDVI

• INSEASON_EVI

• INSEASON_CVI

• INSEASON_GNDVI

• INSEASONPARTIAL_NDVI and INSEASONPARTIAL_EVI

=> Please see this article for detailed information.

• INSEASON_LAI

• INSEASONFIELD_AVERAGE_REVERSE_NDVI

• INSEASONFIELD_AVERAGE_NDVI

• COLORCOMPOSITION

This API retrieves:

• URLs to display coverage maps in PNG, GEOTIFF, Shapefile and KMZ formats, at 5 m resolution;

• URL to display the map thumbnail file as PNG format;

• URL to display the map legend in only available for PNG format;

• URL to display the world-file in PGW format to locate the map;

• URL to display the Notebook map as PNG format to locate the map on a background Google maps ;

• URL to display the scalebar in PNG format;

Authorizations:
oauth2
path Parameters
seasonFieldId
required
string

Filter

query Parameters
$sort
string

Ordered comma separated list of fields to sort on

$filter
string

Filter expression

$fields
string

Comma separated list of fields to retrieve

$group-by
string

Ordered comma separated list of fields to group by

$page-groups
string

Ordered comma separated list of fields to group items on pages by

$column-groups
string

Ordered comma separated list of fields to group columns by

$row-groups
string

Ordered comma separated list of fields to group rows by

$offset
integer <int32>
Default: 0

Offset in the list to get the first item from

$limit
string
Default: "20"

Maximum number of items to return

$count
boolean
Default: false

Returns number of items with the given filter as header

$offset-including
string

Calculates $offset automatically to show given item

$format-settings
string

Input and output format settings

$epsg
string

Input and output geometries projection code

$epsg-in
string

Input geometries projection code

$epsg-out
string

Output geometries projection code

Image.Date
string

Filters search by image date

Image.Sensor
string

Filter by sensor type (SENTINEL_2|DEIMOS_1|ALSAT_1B|RESOURCESAT2|LANDSAT_8|CBERS_4|KAZSTSAT|GAOPFEN)

Image.Weather
string

Filter by weather type (HOT|COLD|WET|DRY)

Image.SoilMaterial
string

Filter by soil material type (BARE|VEGETATION)

Image.IsRecalibrated
boolean

Values: True or False. Value by default: False. Allows to display the re calibrated images or not.

Maps.Type
string

Filter by map type

CoverageType
string

Filter by coverage type (CLEAR|CLOUD|BORDER|NO_DATA|GEOMETRY_ISSUE|RADIOMETRY_ISSUE)

Responses

Response samples

Content type
[
  • {
    }
]

season-fields/{seasonFieldId}/coverage

Authorizations:
oauth2
path Parameters
seasonFieldId
required
string

Filter

query Parameters
$sort
string

Ordered comma separated list of fields to sort on

$filter
string

Filter expression

$fields
string

Comma separated list of fields to retrieve

$group-by
string

Ordered comma separated list of fields to group by

$page-groups
string

Ordered comma separated list of fields to group items on pages by

$column-groups
string

Ordered comma separated list of fields to group columns by

$row-groups
string

Ordered comma separated list of fields to group rows by

$offset
integer <int32>
Default: 0

Offset in the list to get the first item from

$limit
string
Default: "20"

Maximum number of items to return

$count
boolean
Default: true

Returns number of items with the given filter as header

$index-of
string

Returns index of given item in the list as header

$epsg
string

Input and output geometries projection code

$epsg-in
string

Input geometries projection code

$epsg-out
string

Output geometries projection code

Image.Date
string

Filters search by image date

Image.Sensor
string

Filter by sensor type (SENTINEL_2|DEIMOS_1|ALSAT_1B|RESOURCESAT2|LANDSAT_8|CBERS_4|KAZSTSAT|GAOPFEN)

Image.Weather
string

Filter by weather type (HOT|COLD|WET|DRY)

Image.SoilMaterial
string

Filter by soil material type (BARE|VEGETATION)

Image.IsRecalibrated
boolean

Values: True or False. Value by default: False. Allows to display the re calibrated images or not.

Maps.Type
string

Filter by map type

CoverageType
string

Filter by coverage type (CLEAR|CLOUD|BORDER|NO_DATA|GEOMETRY_ISSUE|RADIOMETRY_ISSUE)

Responses

Response samples

Content type
[
  • {
    }
]

season-fields/coverage

This APIs allow to display coverage for a specfic season field id.

This API retrieves a catalog with the following data:

• Available cloud-free imagery dates for the queried field. By default it will return only for the last 6 months.

• The image id

• Sensor

• Soil material: metadata describing if this is a vegetation image or a bare soil image (in text format);

• Weather type: Metadata describing the weather conditions (in text format). The weather type is a metadata that describes the weather conditions at the acquisition date of the image.

The weather type is linked to the image type (Vegetation or Bare soil) and can be defined as follows :

Image Type Weather type Weather type definition
Bare soil Cold The seasonal weather at the image acquisition had been colder than the 30-years average
Bare soil Hot The seasonal weather at the image acquisition had been warmer than the 30-years average 
                                                                                                                                                                                                    |Vegetation | Wet |The seasonal weather at the image acquisition had been **wetter than the 30-years average**
                                                                                                                                                                                                    |Vegetation | Dry |The seasonal weather at the image acquisition had been **dryer than the 30-years average**\.

The map types that can be create are :

• INSEASON_NDVI

• INSEASON_EVI

• INSEASON_CVI

• INSEASON_GNDVI

• INSEASONPARTIAL_NDVI and INSEASONPARTIAL_EVI

=> Please see this article for detailed information.

• INSEASON_LAI

• INSEASONFIELD_AVERAGE_REVERSE_NDVI

• INSEASONFIELD_AVERAGE_NDVI

• COLORCOMPOSITION

This API retrieves:

• URLs to display coverage maps in PNG, GEOTIFF, Shapefile and KMZ formats, at 5 m resolution;

• URL to display the map thumbnail file as PNG format;

• URL to display the map legend in only available for PNG format;

• URL to display the world-file in PGW format to locate the map;

• URL to display the Notebook map as PNG format to locate the map on a background Google maps ;

• URL to display the scalebar in PNG format;

Authorizations:
oauth2
query Parameters
$sort
string

Ordered comma separated list of fields to sort on

$filter
string

Filter expression

$fields
string

Comma separated list of fields to retrieve

$group-by
string

Ordered comma separated list of fields to group by

$page-groups
string

Ordered comma separated list of fields to group items on pages by

$column-groups
string

Ordered comma separated list of fields to group columns by

$row-groups
string

Ordered comma separated list of fields to group rows by

$offset
integer <int32>
Default: 0

Offset in the list to get the first item from

$limit
string
Default: "20"

Maximum number of items to return

$count
boolean
Default: false

Returns number of items with the given filter as header

$offset-including
string

Calculates $offset automatically to show given item

$format-settings
string

Input and output format settings

$epsg
string

Input and output geometries projection code

$epsg-in
string

Input geometries projection code

$epsg-out
string

Output geometries projection code

SeasonField.Id
string
SeasonField.CustomerExternalId
string
Image.Date
string

Filters search by image date

Image.Sensor
string

Filter by sensor type (SENTINEL_2|DEIMOS_1|ALSAT_1B|RESOURCESAT2|LANDSAT_8|CBERS_4|KAZSTSAT|GAOPFEN)

Image.Weather
string

Filter by weather type (HOT|COLD|WET|DRY)

Image.SoilMaterial
string

Filter by soil material type (BARE|VEGETATION)

Image.IsRecalibrated
boolean

Values: True or False. Value by default: False. Allows to display the re calibrated images or not.

Maps.Type
string

Filter by map type

CoverageType
string

Filter by coverage type (CLEAR|CLOUD|BORDER|NO_DATA|GEOMETRY_ISSUE|RADIOMETRY_ISSUE)

Responses

Response samples

Content type
[
  • {
    }
]

DifferenceMap

maps/difference-map/{mapType}

The Difference map endpoint allows to compare two base reference maps from different image dates, in order to identify the main changes inside the field between two moments.

The difference map is built on maps that are part of the same base reference map type (NDVI or EVI).

This API is based on:

• Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• Image dates

This API retrieves:

• URLs to display The Difference map in PNG, GEOTIFF, Shapefile and KMZ formats, at 5 m resolution;

• URL to display The thumbnail file as PNG format;

• URL to display The legend in only available for PNG format;

• URL to display the world-file in PGW format to locate the map;

• URL to display the Notebook map as PNG format to locate the map on a background Google maps ;

• URL to display the scalebar in PNG format;

• URL to recover The HotSpot points in Shapefile, KMZ and GML formats by zone or by segment;

• The Histogram values by classes;

Authorizations:
oauth2
path Parameters
mapType
required
string
Enum: "DIFFERENCE_INSEASON_NDVI" "DIFFERENCE_INSEASON_EVI"
query Parameters
thumbnailSize
integer <int32>

Enable to define size of thumbnail image (square shape)

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string
Request Body schema:
object (ImageReference)
object (ImageReference)
object (SeasonFieldReference)
name
string
tags
Array of strings
object

Responses

Request samples

Content type
{
  • "earliestImage": {
    },
  • "latestImage": {
    },
  • "seasonField": {
    },
  • "name": "string",
  • "tags": [
    ],
  • "externalIds": {
    }
}

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "tags": [
    ],
  • "externalIds": {
    },
  • "seasonField": {
    },
  • "_links": {
    },
  • "index": 0,
  • "hotSpots": [
    ],
  • "legend": {
    },
  • "zones": [
    ],
  • "histogram": {
    },
  • "date": "string",
  • "worldFile": {
    },
  • "mapSize": "string",
  • "bBox": {
    }
}

map-sets/difference-map/{mapType}

This API allows to compare a set of several difference maps. Difference maps compare two base reference maps from different image dates, in order to identify the main changes inside the field between two moments.

The difference map is built on maps that are part of the same base reference map type (NDVI or EVI).

This API is based on:

• Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• Image dates

This API retrieves:

• URLs to display The Difference maps in PNG, GEOTIFF, Shapefile and KMZ formats, at 5 m resolution;

• URL to display The thumbnail file as PNG format;

• URL to display The legend in only available for PNG format;

• URL to display the world-file in PGW format to locate the map;

• URL to display the Notebook map as PNG format to locate the map on a background Google maps ;

• URL to display the scalebar in PNG format;

• URL to recover The HotSpot points in Shapefile, KMZ and GML formats by zone or by segment;

• The Histogram values by classes;

Authorizations:
oauth2
path Parameters
mapType
required
string
Enum: "DIFFERENCE_INSEASON_NDVI" "DIFFERENCE_INSEASON_EVI"
query Parameters
directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string
Request Body schema:
imageMimeType
string
Array of objects (DifferenceMapBodyParameters)

Responses

Request samples

Content type
{
  • "imageMimeType": "string",
  • "mapParams": [
    ]
}

Response samples

Content type
[
  • {
    }
]

season-fields/{seasonFieldId}/coverage/{latestImageReference}/base-reference-map/{mapType}/difference-with/{earliestImageReference}

This API allows to request Difference map by using shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The first image date

• The latest image date

• The map Type

The images date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map types are :

• Difference_inseason_NDVI

• Difference_inseason_EVI

Authorizations:
oauth2
path Parameters
mapType
required
string
Enum: "DIFFERENCE_INSEASON_NDVI" "DIFFERENCE_INSEASON_EVI"
latestImageReference
required
string
earliestImageReference
required
string
seasonFieldId
required
string

Season field id

query Parameters
thumbnailSize
integer <int32>

Enable to define size of thumbnail image (square shape)

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "tags": [
    ],
  • "externalIds": {
    },
  • "seasonField": {
    },
  • "_links": {
    },
  • "index": 0,
  • "hotSpots": [
    ],
  • "legend": {
    },
  • "zones": [
    ],
  • "histogram": {
    },
  • "date": "string",
  • "worldFile": {
    },
  • "mapSize": "string",
  • "bBox": {
    }
}

season-fields/{seasonFieldId}/coverage/{latestImageReference}/base-reference-map/{mapType}/difference-with/{earliestImageReference}/hotspot{extension}

This API allows you to request the file containing hotspots of the difference map by using shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The first image date

• The latest image date

• The map Type

The images date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map types are :

• Difference_inseason_NDVI

• Difference_inseason_EVI

Authorizations:
oauth2
path Parameters
mapType
required
string
Enum: "DIFFERENCE_INSEASON_NDVI" "DIFFERENCE_INSEASON_EVI"
latestImageReference
required
string
earliestImageReference
required
string
seasonFieldId
required
string

Season field id

extension
required
string
Enum: ".kml" ".shp.zip" ".gml"
query Parameters
directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/coverage/{latestImageReference}/base-reference-map/{mapType}/difference-with/{earliestImageReference}/image{extension}

This API allows to request the difference map image by using Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The first image date

• The latest image date

• The map Type

The images date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map types are :

• Difference_inseason_NDVI

• Difference_inseason_EVI

The available extensions are:

• .shp.zip

• .tiff

• .kmz

• .png

Authorizations:
oauth2
path Parameters
mapType
required
string
Enum: "DIFFERENCE_INSEASON_NDVI" "DIFFERENCE_INSEASON_EVI"
latestImageReference
required
string
earliestImageReference
required
string
seasonFieldId
required
string

Season field id

extension
required
string
Enum: ".png" ".tiff.zip" ".shp.zip" ".kmz"
query Parameters
directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/coverage/{latestImageReference}/base-reference-map/{mapType}/difference-with/{earliestImageReference}/legend.png

This API allows to request the difference map legend in PNG format by using by using Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The first image date

• The latest image date

• The map Type

The images date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map types are :

• Difference_inseason_NDVI

• Difference_inseason_EVI

Authorizations:
oauth2
path Parameters
mapType
required
string
Enum: "DIFFERENCE_INSEASON_NDVI" "DIFFERENCE_INSEASON_EVI"
latestImageReference
required
string
earliestImageReference
required
string
seasonFieldId
required
string

Season field id

query Parameters
directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

Responses

season-fields/{seasonFieldId}/coverage/{latestImageReference}/base-reference-map/{mapType}/difference-with/{earliestImageReference}/notebook.png

This API allows to request the difference map Notebook in PNG format by using Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The first image date

• The latest image date

• The map Type

The images date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map types are :

• Difference_inseason_NDVI

• Difference_inseason_EVI

Authorizations:
oauth2
path Parameters
mapType
required
string
Enum: "DIFFERENCE_INSEASON_NDVI" "DIFFERENCE_INSEASON_EVI"
latestImageReference
required
string
earliestImageReference
required
string
seasonFieldId
required
string

Season field id

query Parameters
directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/coverage/{latestImageReference}/base-reference-map/{mapType}/difference-with/{earliestImageReference}/scalebar.png

This API allows to request the difference map scalebar in PNG format by using Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The first image date

• The latest image date

• The map Type

The images date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map types are :

• Difference_inseason_NDVI

• Difference_inseason_EVI

Authorizations:
oauth2
path Parameters
mapType
required
string
Enum: "DIFFERENCE_INSEASON_NDVI" "DIFFERENCE_INSEASON_EVI"
latestImageReference
required
string
earliestImageReference
required
string
seasonFieldId
required
string

Season field id

query Parameters
directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/coverage/{latestImageReference}/base-reference-map/{mapType}/difference-with/{earliestImageReference}/thumbnail.png

This API allows to request the difference map thumbnail in PNG format by using Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The first image date

• The latest image date

• The map Type

The images date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map types are :

• Difference_inseason_NDVI

• Difference_inseason_EVI

Authorizations:
oauth2
path Parameters
mapType
required
string
Enum: "DIFFERENCE_INSEASON_NDVI" "DIFFERENCE_INSEASON_EVI"
latestImageReference
required
string
earliestImageReference
required
string
seasonFieldId
required
string

Season field id

query Parameters
thumbnailSize
integer <int32>

Enable to define size of thumbnail image (square shape)

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/coverage/{latestImageReference}/base-reference-map/{mapType}/difference-with/{earliestImageReference}/world-file.pgw

This API allows to request the world-file in PGW format to locate the difference map with Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The first image date

• The latest image date

• The map Type

The images date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map types are :

• Difference_inseason_NDVI

• Difference_inseason_EVI

Authorizations:
oauth2
path Parameters
mapType
required
string
Enum: "DIFFERENCE_INSEASON_NDVI" "DIFFERENCE_INSEASON_EVI"
latestImageReference
required
string
earliestImageReference
required
string
seasonFieldId
required
string

Season field id

query Parameters
directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

FieldBorder

maps/field-border-map

This APIs allows to display field border according to its geometry.

This API is based on:

• Geometry

This API retrieves:

• URL to display the field border map as PNG format to locate the field border on a background Google maps;

• URL to display the scalebar in PNG format;

Authorizations:
oauth2
query Parameters
$epsg-out
integer <int32>

Output geometries projection code

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

header Parameters
headerParameters
string
Request Body schema:
geometry
string
object (SeasonFieldReference)

Responses

Request samples

Content type
{
  • "geometry": "string",
  • "seasonField": {
    }
}

Response samples

Content type
{
  • "index": 0,
  • "seasonField": {
    },
  • "_links": {
    }
}

map-sets/field-border-map

This APIs allows to display a set of several field border maps according to their geometry.

This API is based on:

• Geometry

This API retrieves:

• URL to display the field border maps as PNG format to locate the field border on a background Google maps;

• URL to display the scalebar in PNG format;

Authorizations:
oauth2
query Parameters
$epsg-out
integer <int32>

Output geometries projection code

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

header Parameters
headerParameters
string
Request Body schema:
Array of objects (FieldBorderBodyParameters)

Responses

Request samples

Content type
{
  • "mapParams": [
    ]
}

Response samples

Content type
{
  • "maps": [
    ]
}

season-fields/{seasonFieldId}/field-border-map

This API allows to request Field border map by using shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

The map type is :

• FIELDBORDER

Authorizations:
oauth2
path Parameters
mapType
required
string
Value: "FIELDBORDER"
seasonFieldId
required
string

Season field id

query Parameters
$epsg-out
integer <int32>

Output geometries projection code

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/field-border-map/notebook.png

This API allows to request the field border Notebook in PNG format by using Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

The map type is :

• FIELDBORDER

Authorizations:
oauth2
path Parameters
mapType
required
string
Value: "FIELDBORDER"
seasonFieldId
required
string

Season field id

query Parameters
$epsg-out
integer <int32>

Output geometries projection code

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/field-border-map/scalebar.png

This API allows to request the field border scalebar in PNG format by using Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

The map type is :

• FIELDBORDER

Authorizations:
oauth2
path Parameters
mapType
required
string
Value: "FIELDBORDER"
seasonFieldId
required
string

Season field id

query Parameters
$epsg-out
integer <int32>

Output geometries projection code

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

header Parameters
headerParameters
string

Responses

Map

maps

This API allows to create one new map for specific parameters.

Authorizations:
oauth2
query Parameters
$epsg-out
integer <int32>

Output geometries projection code

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

userId
string

Filter

$sort
string

Ordered comma separated list of fields to sort on

$filter
string

Filter expression

$fields
string

Comma separated list of fields to retrieve

$group-by
string

Ordered comma separated list of fields to group by

$page-groups
string

Ordered comma separated list of fields to group items on pages by

$column-groups
string

Ordered comma separated list of fields to group columns by

$row-groups
string

Ordered comma separated list of fields to group rows by

$offset
integer <int32>
Default: 0

Offset in the list to get the first item from

$limit
string
Default: "20"

Maximum number of items to return

$count
boolean
Default: false

Returns number of items with the given filter as header

$offset-including
string

Calculates $offset automatically to show given item

$format-settings
string

Input and output format settings

$epsg
string

Input and output geometries projection code

$epsg-in
string

Input geometries projection code

$epsg-out
string

Output geometries projection code

header Parameters
headerParameters
string

Filter

Responses

maps

Authorizations:
oauth2
query Parameters
$epsg-out
integer <int32>

Output geometries projection code

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

userId
string

Filter

$sort
string

Ordered comma separated list of fields to sort on

$filter
string

Filter expression

$fields
string

Comma separated list of fields to retrieve

$group-by
string

Ordered comma separated list of fields to group by

$page-groups
string

Ordered comma separated list of fields to group items on pages by

$column-groups
string

Ordered comma separated list of fields to group columns by

$row-groups
string

Ordered comma separated list of fields to group rows by

$offset
integer <int32>
Default: 0

Offset in the list to get the first item from

$limit
string
Default: "20"

Maximum number of items to return

$count
boolean
Default: true

Returns number of items with the given filter as header

$index-of
string

Returns index of given item in the list as header

$epsg
string

Input and output geometries projection code

$epsg-in
string

Input geometries projection code

$epsg-out
string

Output geometries projection code

header Parameters
headerParameters
string

Filter

Responses

maps/{id}

This API allows to request specific map by using shortcuts (More information about shortcuts here) :

• The image identifier

Authorizations:
oauth2
path Parameters
id
required
string
query Parameters
$epsg-out
integer <int32>

Output geometries projection code

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

$fields
string

Comma separated list of fields to retrieve

header Parameters
headerParameters
string

Responses

maps/{id}

Authorizations:
oauth2
path Parameters
id
required
string

Responses

maps/{id}

Authorizations:
oauth2
path Parameters
id
required
string
Request Body schema:
Array
value
object
path
string
op
string
from
string

Responses

Request samples

Content type
[
  • {
    }
]

maps/{id}/image{extension}

This API allows to request the map by using shortcuts (More information about shortcuts here) :

• The image identifier

• The extension

The available extensions are:

• .shp.zip

• .tiff.zip

• .kmz

• .png

Authorizations:
oauth2
path Parameters
id
required
string
extension
required
string
Enum: ".png" ".tiff.zip" ".shp.zip" ".kmz"
query Parameters
$epsg-out
integer <int32>

Output geometries projection code

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

header Parameters
headerParameters
string

Responses

maps/{id}/legend.png

This API allows to request the Map legend in PNG format by using Shortcuts :

• The image identifier

• The extension

Authorizations:
oauth2
path Parameters
id
required
string
query Parameters
$epsg-out
integer <int32>

Output geometries projection code

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

header Parameters
headerParameters
string

Responses

maps/{id}/notebook.png

This API allows to request the Map notebook in PNG format by using Shortcuts :

• The image identifier

• The extension

Authorizations:
oauth2
path Parameters
id
required
string
extension
required
string
Enum: ".png" ".tiff.zip" ".shp.zip" ".kmz"
query Parameters
$epsg-out
integer <int32>

Output geometries projection code

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

header Parameters
headerParameters
string

Responses

maps/{id}/scalebar.png

This API allows to request the scalebar map in png format by using shortcuts :

• The image identifier

• The extension

Authorizations:
oauth2
path Parameters
id
required
string
extension
required
string
Enum: ".png" ".tiff.zip" ".shp.zip" ".kmz"
query Parameters
$epsg-out
integer <int32>

Output geometries projection code

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

header Parameters
headerParameters
string

Responses

maps/{id}/thumbnail.png

This API allows to request the Map thumbnail in PNG format by using Shortcuts :

• The image identifier

• The extension

Authorizations:
oauth2
path Parameters
id
required
string
query Parameters
thumbnailSize
integer <int32>

Enable to define size of thumbnail image (square shape)

$epsg-out
integer <int32>

Output geometries projection code

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

header Parameters
headerParameters
string

Responses

maps/{id}/world-file.pgw

This API allows to request the world-file in PGW format to locate the map with shortcuts :

• The image identifier

• The extension

Authorizations:
oauth2
path Parameters
id
required
string
query Parameters
$epsg-out
integer <int32>

Output geometries projection code

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

header Parameters
headerParameters
string

Responses

ModelMap

maps/model-map/{mapType}

This API allows to display a NDVI or LAI map from the current crop season for a field, based on an image date (using the Coverage API) and for the N parameters.

• Field average: is applying N depending on the average LAI of the field. The ultimate goal is to manage crop canopy variation. The area below average LAI will receive more nitrogen.

• Field average reverse: is applying N depending on the average LAI of the field. The ultimate goal is to increase yield and protein content. The area above average LAI will receive more nitrogen.

• Canopy N reverse: The ultimate goal is to increase yield. The area above the average LAI will receive more Nitrogen.

This API retrieves:

• URLs to display the model map in PNG, GEOTIFF, SHAPEFILE and KMZ formats, at 5 m resolution;

• URL to display the map thumbnail file as PNG format;

• URL to display the map legend in only available for PNG format;

• URL to display the world-file in PGW format to locate the map;

• URL to display the Notebook map as PNG format to locate the map on a Google maps background;

• URL to display the scalebar in PNG format;

• URL to recover The HotSpot points in Shapefile, KMZ and GML formats by zone or by segment;

• The Histogram values by classes;

Authorizations:
oauth2
path Parameters
mapType
required
string
Enum: "INSEASONCANOPY_N_REVERSE_LAI" "INSEASONFIELD_AVERAGE_LAI" "INSEASONFIELD_AVERAGE_NDVI" "INSEASONFIELD_AVERAGE_REVERSE_LAI" "INSEASONFIELD_AVERAGE_REVERSE_NDVI" "INSEASON_PRECO_N_GENERIC_MODEL_NDVI" "INSEASON_PRECO_N_GENERIC_MODEL_CVIN" "INSEASON_PRECO_N_GENERIC_MODEL_LAI" "INSEASON_PRECO_N_GENERIC_MODEL_INVERSE_NDVI" "INSEASON_PRECO_N_GENERIC_MODEL_INVERSE_CVIN" "INSEASON_PRECO_N_GENERIC_MODEL_INVERSE_LAI"
query Parameters
thumbnailSize
integer <int32>

Enable to define size of thumbnail image (square shape)

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string
Request Body schema:
object (ImageReference)
nPlanned
number <float>
nMin
number <float>
nMax
number <float>
offset
number <double>
gain
number <double>
object (SeasonFieldReference)
name
string
tags
Array of strings
object

Responses

Request samples

Content type
{
  • "image": {
    },
  • "nPlanned": 0,
  • "nMin": 0,
  • "nMax": 0,
  • "offset": 0,
  • "gain": 0,
  • "seasonField": {
    },
  • "name": "string",
  • "tags": [
    ],
  • "externalIds": {
    }
}

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "tags": [
    ],
  • "externalIds": {
    },
  • "seasonField": {
    },
  • "_links": {
    },
  • "index": 0,
  • "hotSpots": [
    ],
  • "legend": {
    },
  • "zones": [
    ],
  • "histogram": {
    },
  • "date": "string",
  • "worldFile": {
    },
  • "mapSize": "string",
  • "bBox": {
    }
}

map-sets/model-map/{mapType}

This API allows to display a set of several NDVI maps or LAI maps from their current crop season and their field, based on an image date (using the Coverage API) and for the N parameters.

• Field average: is applying N depending on the average LAI of the field. The ultimate goal is to manage crop canopy variation. The area below average LAI will receive more nitrogen.

• Field average reverse: is applying N depending on the average LAI of the field. The ultimate goal is to increase yield and protein content. The area above average LAI will receive more nitrogen.

• Canopy N reverse: The ultimate goal is to increase yield. The area above the average LAI will receive more Nitrogen.

This API retrieves:

• URLs to display the model map in PNG, GEOTIFF, SHAPEFILE and KMZ formats, at 5 m resolution;

• URL to display the map thumbnail file as PNG format;

• URL to display the map legend in only available for PNG format;

• URL to display the world-file in PGW format to locate the map;

• URL to display the Notebook map as PNG format to locate the map on a Google maps background;

• URL to display the scalebar in PNG format;

• URL to recover The HotSpot points in Shapefile, KMZ and GML formats by zone or by segment;

• The Histogram values by classes;

Authorizations:
oauth2
path Parameters
mapType
required
string
Enum: "INSEASONCANOPY_N_REVERSE_LAI" "INSEASONFIELD_AVERAGE_LAI" "INSEASONFIELD_AVERAGE_NDVI" "INSEASONFIELD_AVERAGE_REVERSE_LAI" "INSEASONFIELD_AVERAGE_REVERSE_NDVI" "INSEASON_PRECO_N_GENERIC_MODEL_NDVI" "INSEASON_PRECO_N_GENERIC_MODEL_CVIN" "INSEASON_PRECO_N_GENERIC_MODEL_LAI" "INSEASON_PRECO_N_GENERIC_MODEL_INVERSE_NDVI" "INSEASON_PRECO_N_GENERIC_MODEL_INVERSE_CVIN" "INSEASON_PRECO_N_GENERIC_MODEL_INVERSE_LAI"
query Parameters
directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string
Request Body schema:
imageMimeType
string
Array of objects (ModelMapBodyParameters)

Responses

Request samples

Content type
{
  • "imageMimeType": "string",
  • "mapParams": [
    ]
}

Response samples

Content type
[
  • {
    }
]

season-fields/{seasonFieldId}/coverage/{imageReference}/model-map/{mapType}/n-planned/{nPlanned}

This API allows to request the model map by using shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• the image date reference

• The map Type

• N planned value

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map types are :

• INSEASONCANOPY_N_REVERSE_LAI

• INSEASONFIELD_AVERAGE_LAI

• INSEASONFIELD_AVERAGE_NDVI

• INSEASONFIELD_AVERAGE_REVERSE_LAI

• INSEASONFIELD_AVERAGE_REVERSE_NDVI

• INSEASON_PRECO_N_GENERIC_MODEL_NDVI

• INSEASON_PRECO_N_GENERIC_MODEL_CVIN

• INSEASON_PRECO_N_GENERIC_MODEL_LAI

• INSEASON_PRECO_N_GENERIC_MODEL_INVERSE_NDVI

• INSEASON_PRECO_N_GENERIC_MODEL_INVERSE_CVIN

• INSEASON_PRECO_N_GENERIC_MODEL_INVERSE_LAI

Authorizations:
oauth2
path Parameters
imageReference
required
string

Image reference using either the image date or the image id

nPlanned
required
number <float>

Dose of Nitrogen planned units depend on User profile. UK: kg / ha

mapType
required
string
Enum: "INSEASONCANOPY_N_REVERSE_LAI" "INSEASONFIELD_AVERAGE_LAI" "INSEASONFIELD_AVERAGE_NDVI" "INSEASONFIELD_AVERAGE_REVERSE_LAI" "INSEASONFIELD_AVERAGE_REVERSE_NDVI" "INSEASON_PRECO_N_GENERIC_MODEL_NDVI" "INSEASON_PRECO_N_GENERIC_MODEL_CVIN" "INSEASON_PRECO_N_GENERIC_MODEL_LAI" "INSEASON_PRECO_N_GENERIC_MODEL_INVERSE_NDVI" "INSEASON_PRECO_N_GENERIC_MODEL_INVERSE_CVIN" "INSEASON_PRECO_N_GENERIC_MODEL_INVERSE_LAI"
seasonFieldId
required
string

Season field id

query Parameters
thumbnailSize
integer <int32>

Enable to define size of thumbnail image (square shape)

gain
number <double>

This parameter allows to multiply a base reference map value with a constant gain factor. Default value : 1

offset
number <double>

This parameter allows to add a constant offset on the base reference map value. Default value : 0

nMax
number <float>

Maximum threshold for the N dose Minimum value allowed is 0. Maximum value allowed is 999.

nMin
number <float>

Minimum threshold for the N dose Minimum value allowed is 0. Maximum value allowed is 999.

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "tags": [
    ],
  • "externalIds": {
    },
  • "seasonField": {
    },
  • "_links": {
    },
  • "index": 0,
  • "hotSpots": [
    ],
  • "legend": {
    },
  • "zones": [
    ],
  • "histogram": {
    },
  • "date": "string",
  • "worldFile": {
    },
  • "mapSize": "string",
  • "bBox": {
    }
}

season-fields/{seasonFieldId}/coverage/{imageReference}/model-map/{mapType}/n-planned/{nPlanned}/hotspot{extension}

This API allows you to request the file containing hotspots of the Model map by using shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• the image date reference

• The map Type

• N planned value

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map types are :

• INSEASONCANOPY_N_REVERSE_LAI

• INSEASONFIELD_AVERAGE_LAI

• INSEASONFIELD_AVERAGE_NDVI

• INSEASONFIELD_AVERAGE_REVERSE_LAI

• INSEASONFIELD_AVERAGE_REVERSE_NDVI

• INSEASON_PRECO_N_GENERIC_MODEL_NDVI

• INSEASON_PRECO_N_GENERIC_MODEL_CVIN

• INSEASON_PRECO_N_GENERIC_MODEL_LAI

• INSEASON_PRECO_N_GENERIC_MODEL_INVERSE_NDVI

• INSEASON_PRECO_N_GENERIC_MODEL_INVERSE_CVIN

• INSEASON_PRECO_N_GENERIC_MODEL_INVERSE_LAI

Authorizations:
oauth2
path Parameters
imageReference
required
string

Image reference using either the image date or the image id

nPlanned
required
number <float>

Dose of Nitrogen planned units depend on User profile. UK: kg / ha

mapType
required
string
Enum: "INSEASONCANOPY_N_REVERSE_LAI" "INSEASONFIELD_AVERAGE_LAI" "INSEASONFIELD_AVERAGE_NDVI" "INSEASONFIELD_AVERAGE_REVERSE_LAI" "INSEASONFIELD_AVERAGE_REVERSE_NDVI" "INSEASON_PRECO_N_GENERIC_MODEL_NDVI" "INSEASON_PRECO_N_GENERIC_MODEL_CVIN" "INSEASON_PRECO_N_GENERIC_MODEL_LAI" "INSEASON_PRECO_N_GENERIC_MODEL_INVERSE_NDVI" "INSEASON_PRECO_N_GENERIC_MODEL_INVERSE_CVIN" "INSEASON_PRECO_N_GENERIC_MODEL_INVERSE_LAI"
seasonFieldId
required
string

Season field id

extension
required
string
Enum: ".kml" ".shp.zip" ".gml"
query Parameters
gain
number <double>

This parameter allows to multiply a base reference map value with a constant gain factor. Default value : 1

offset
number <double>

This parameter allows to add a constant offset on the base reference map value. Default value : 0

nMax
number <float>

Maximum threshold for the N dose Minimum value allowed is 0. Maximum value allowed is 999.

nMin
number <float>

Minimum threshold for the N dose Minimum value allowed is 0. Maximum value allowed is 999.

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/coverage/{imageReference}/model-map/{mapType}/n-planned/{nPlanned}/image{extension}

This API allows to request the model map image by using Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• the image date reference

• The map Type

• N planned value

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map types are :

• INSEASONCANOPY_N_REVERSE_LAI

• INSEASONFIELD_AVERAGE_LAI

• INSEASONFIELD_AVERAGE_NDVI

• INSEASONFIELD_AVERAGE_REVERSE_LAI

• INSEASONFIELD_AVERAGE_REVERSE_NDVI

• INSEASON_PRECO_N_GENERIC_MODEL_NDVI

• INSEASON_PRECO_N_GENERIC_MODEL_CVIN

• INSEASON_PRECO_N_GENERIC_MODEL_LAI

• INSEASON_PRECO_N_GENERIC_MODEL_INVERSE_NDVI

• INSEASON_PRECO_N_GENERIC_MODEL_INVERSE_CVIN

• INSEASON_PRECO_N_GENERIC_MODEL_INVERSE_LAI

The available extensions are:

• .shp.zip

• .tiff

• .kmz

• .png

Authorizations:
oauth2
path Parameters
imageReference
required
string

Image reference using either the image date or the image id

nPlanned
required
number <float>

Dose of Nitrogen planned units depend on User profile. UK: kg / ha

mapType
required
string
Enum: "INSEASONCANOPY_N_REVERSE_LAI" "INSEASONFIELD_AVERAGE_LAI" "INSEASONFIELD_AVERAGE_NDVI" "INSEASONFIELD_AVERAGE_REVERSE_LAI" "INSEASONFIELD_AVERAGE_REVERSE_NDVI" "INSEASON_PRECO_N_GENERIC_MODEL_NDVI" "INSEASON_PRECO_N_GENERIC_MODEL_CVIN" "INSEASON_PRECO_N_GENERIC_MODEL_LAI" "INSEASON_PRECO_N_GENERIC_MODEL_INVERSE_NDVI" "INSEASON_PRECO_N_GENERIC_MODEL_INVERSE_CVIN" "INSEASON_PRECO_N_GENERIC_MODEL_INVERSE_LAI"
seasonFieldId
required
string

Season field id

extension
required
string
Enum: ".png" ".tiff.zip" ".shp.zip" ".kmz"
query Parameters
gain
number <double>

This parameter allows to multiply a base reference map value with a constant gain factor. Default value : 1

offset
number <double>

This parameter allows to add a constant offset on the base reference map value. Default value : 0

nMax
number <float>

Maximum threshold for the N dose Minimum value allowed is 0. Maximum value allowed is 999.

nMin
number <float>

Minimum threshold for the N dose Minimum value allowed is 0. Maximum value allowed is 999.

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/coverage/{imageReference}/model-map/{mapType}/n-planned/{nPlanned}/legend.png

this API allows to request the model map legend in PNG format by using Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• the image date reference

• The map Type

• N planned value

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map types are :

• INSEASONCANOPY_N_REVERSE_LAI

• INSEASONFIELD_AVERAGE_LAI

• INSEASONFIELD_AVERAGE_NDVI

• INSEASONFIELD_AVERAGE_REVERSE_LAI

• INSEASONFIELD_AVERAGE_REVERSE_NDVI

• INSEASON_PRECO_N_GENERIC_MODEL_NDVI

• INSEASON_PRECO_N_GENERIC_MODEL_CVIN

• INSEASON_PRECO_N_GENERIC_MODEL_LAI

• INSEASON_PRECO_N_GENERIC_MODEL_INVERSE_NDVI

• INSEASON_PRECO_N_GENERIC_MODEL_INVERSE_CVIN

• INSEASON_PRECO_N_GENERIC_MODEL_INVERSE_LAI

Authorizations:
oauth2
path Parameters
imageReference
required
string

Image reference using either the image date or the image id

nPlanned
required
number <float>

Dose of Nitrogen planned units depend on User profile. UK: kg / ha

mapType
required
string
Enum: "INSEASONCANOPY_N_REVERSE_LAI" "INSEASONFIELD_AVERAGE_LAI" "INSEASONFIELD_AVERAGE_NDVI" "INSEASONFIELD_AVERAGE_REVERSE_LAI" "INSEASONFIELD_AVERAGE_REVERSE_NDVI" "INSEASON_PRECO_N_GENERIC_MODEL_NDVI" "INSEASON_PRECO_N_GENERIC_MODEL_CVIN" "INSEASON_PRECO_N_GENERIC_MODEL_LAI" "INSEASON_PRECO_N_GENERIC_MODEL_INVERSE_NDVI" "INSEASON_PRECO_N_GENERIC_MODEL_INVERSE_CVIN" "INSEASON_PRECO_N_GENERIC_MODEL_INVERSE_LAI"
seasonFieldId
required
string

Season field id

query Parameters
gain
number <double>

This parameter allows to multiply a base reference map value with a constant gain factor. Default value : 1

offset
number <double>

This parameter allows to add a constant offset on the base reference map value. Default value : 0

nMax
number <float>

Maximum threshold for the N dose Minimum value allowed is 0. Maximum value allowed is 999.

nMin
number <float>

Minimum threshold for the N dose Minimum value allowed is 0. Maximum value allowed is 999.

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

Responses

season-fields/{seasonFieldId}/coverage/{imageReference}/model-map/{mapType}/n-planned/{nPlanned}/notebook.png

this API allows to request the model map notebook in PNG format by using Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• the image date reference

• The map Type

• N planned value

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map types are :

• INSEASONCANOPY_N_REVERSE_LAI

• INSEASONFIELD_AVERAGE_LAI

• INSEASONFIELD_AVERAGE_NDVI

• INSEASONFIELD_AVERAGE_REVERSE_LAI

• INSEASONFIELD_AVERAGE_REVERSE_NDVI

• INSEASON_PRECO_N_GENERIC_MODEL_NDVI

• INSEASON_PRECO_N_GENERIC_MODEL_CVIN

• INSEASON_PRECO_N_GENERIC_MODEL_LAI

• INSEASON_PRECO_N_GENERIC_MODEL_INVERSE_NDVI

• INSEASON_PRECO_N_GENERIC_MODEL_INVERSE_CVIN

• INSEASON_PRECO_N_GENERIC_MODEL_INVERSE_LAI

Authorizations:
oauth2
path Parameters
imageReference
required
string

Image reference using either the image date or the image id

nPlanned
required
number <float>

Dose of Nitrogen planned units depend on User profile. UK: kg / ha

mapType
required
string
Enum: "INSEASONCANOPY_N_REVERSE_LAI" "INSEASONFIELD_AVERAGE_LAI" "INSEASONFIELD_AVERAGE_NDVI" "INSEASONFIELD_AVERAGE_REVERSE_LAI" "INSEASONFIELD_AVERAGE_REVERSE_NDVI" "INSEASON_PRECO_N_GENERIC_MODEL_NDVI" "INSEASON_PRECO_N_GENERIC_MODEL_CVIN" "INSEASON_PRECO_N_GENERIC_MODEL_LAI" "INSEASON_PRECO_N_GENERIC_MODEL_INVERSE_NDVI" "INSEASON_PRECO_N_GENERIC_MODEL_INVERSE_CVIN" "INSEASON_PRECO_N_GENERIC_MODEL_INVERSE_LAI"
seasonFieldId
required
string

Season field id

query Parameters
gain
number <double>

This parameter allows to multiply a base reference map value with a constant gain factor. Default value : 1

offset
number <double>

This parameter allows to add a constant offset on the base reference map value. Default value : 0

nMax
number <float>

Maximum threshold for the N dose Minimum value allowed is 0. Maximum value allowed is 999.

nMin
number <float>

Minimum threshold for the N dose Minimum value allowed is 0. Maximum value allowed is 999.

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/coverage/{imageReference}/model-map/{mapType}/n-planned/{nPlanned}/scalebar.png

this API allows to request the model map scalebar in PNG format by using Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• the image date reference

• The map Type

• N planned value

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map types are :

• INSEASONCANOPY_N_REVERSE_LAI

• INSEASONFIELD_AVERAGE_LAI

• INSEASONFIELD_AVERAGE_NDVI

• INSEASONFIELD_AVERAGE_REVERSE_LAI

• INSEASONFIELD_AVERAGE_REVERSE_NDVI

• INSEASON_PRECO_N_GENERIC_MODEL_NDVI

• INSEASON_PRECO_N_GENERIC_MODEL_CVIN

• INSEASON_PRECO_N_GENERIC_MODEL_LAI

• INSEASON_PRECO_N_GENERIC_MODEL_INVERSE_NDVI

• INSEASON_PRECO_N_GENERIC_MODEL_INVERSE_CVIN

• INSEASON_PRECO_N_GENERIC_MODEL_INVERSE_LAI

Authorizations:
oauth2
path Parameters
imageReference
required
string

Image reference using either the image date or the image id

nPlanned
required
number <float>

Dose of Nitrogen planned units depend on User profile. UK: kg / ha

mapType
required
string
Enum: "INSEASONCANOPY_N_REVERSE_LAI" "INSEASONFIELD_AVERAGE_LAI" "INSEASONFIELD_AVERAGE_NDVI" "INSEASONFIELD_AVERAGE_REVERSE_LAI" "INSEASONFIELD_AVERAGE_REVERSE_NDVI" "INSEASON_PRECO_N_GENERIC_MODEL_NDVI" "INSEASON_PRECO_N_GENERIC_MODEL_CVIN" "INSEASON_PRECO_N_GENERIC_MODEL_LAI" "INSEASON_PRECO_N_GENERIC_MODEL_INVERSE_NDVI" "INSEASON_PRECO_N_GENERIC_MODEL_INVERSE_CVIN" "INSEASON_PRECO_N_GENERIC_MODEL_INVERSE_LAI"
seasonFieldId
required
string

Season field id

query Parameters
gain
number <double>

This parameter allows to multiply a base reference map value with a constant gain factor. Default value : 1

offset
number <double>

This parameter allows to add a constant offset on the base reference map value. Default value : 0

nMax
number <float>

Maximum threshold for the N dose Minimum value allowed is 0. Maximum value allowed is 999.

nMin
number <float>

Minimum threshold for the N dose Minimum value allowed is 0. Maximum value allowed is 999.

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/coverage/{imageReference}/model-map/{mapType}/n-planned/{nPlanned}/thumbnail.png

this API allows to request the model map thumbnail in PNG format by using Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• the image date reference

• The map Type

• N planned value

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map types are :

• INSEASONCANOPY_N_REVERSE_LAI

• INSEASONFIELD_AVERAGE_LAI

• INSEASONFIELD_AVERAGE_NDVI

• INSEASONFIELD_AVERAGE_REVERSE_LAI

• INSEASONFIELD_AVERAGE_REVERSE_NDVI

• INSEASON_PRECO_N_GENERIC_MODEL_NDVI

• INSEASON_PRECO_N_GENERIC_MODEL_CVIN

• INSEASON_PRECO_N_GENERIC_MODEL_LAI

• INSEASON_PRECO_N_GENERIC_MODEL_INVERSE_NDVI

• INSEASON_PRECO_N_GENERIC_MODEL_INVERSE_CVIN

• INSEASON_PRECO_N_GENERIC_MODEL_INVERSE_LAI

Authorizations:
oauth2
path Parameters
imageReference
required
string

Image reference using either the image date or the image id

nPlanned
required
number <float>

Dose of Nitrogen planned units depend on User profile. UK: kg / ha

mapType
required
string
Enum: "INSEASONCANOPY_N_REVERSE_LAI" "INSEASONFIELD_AVERAGE_LAI" "INSEASONFIELD_AVERAGE_NDVI" "INSEASONFIELD_AVERAGE_REVERSE_LAI" "INSEASONFIELD_AVERAGE_REVERSE_NDVI" "INSEASON_PRECO_N_GENERIC_MODEL_NDVI" "INSEASON_PRECO_N_GENERIC_MODEL_CVIN" "INSEASON_PRECO_N_GENERIC_MODEL_LAI" "INSEASON_PRECO_N_GENERIC_MODEL_INVERSE_NDVI" "INSEASON_PRECO_N_GENERIC_MODEL_INVERSE_CVIN" "INSEASON_PRECO_N_GENERIC_MODEL_INVERSE_LAI"
seasonFieldId
required
string

Season field id

query Parameters
thumbnailSize
integer <int32>

Enable to define size of thumbnail image (square shape)

gain
number <double>

This parameter allows to multiply a base reference map value with a constant gain factor. Default value : 1

offset
number <double>

This parameter allows to add a constant offset on the base reference map value. Default value : 0

nMax
number <float>

Maximum threshold for the N dose Minimum value allowed is 0. Maximum value allowed is 999.

nMin
number <float>

Minimum threshold for the N dose Minimum value allowed is 0. Maximum value allowed is 999.

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/coverage/{imageReference}/model-map/{mapType}/n-planned/{nPlanned}/world-file.pgw

This API allows to request the world-file in PGW format to locate the Model map with Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• the image date reference

• The map Type

• N planned value

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map types are :

• INSEASONCANOPY_N_REVERSE_LAI

• INSEASONFIELD_AVERAGE_LAI

• INSEASONFIELD_AVERAGE_NDVI

• INSEASONFIELD_AVERAGE_REVERSE_LAI

• INSEASONFIELD_AVERAGE_REVERSE_NDVI

• INSEASON_PRECO_N_GENERIC_MODEL_NDVI

• INSEASON_PRECO_N_GENERIC_MODEL_CVIN

• INSEASON_PRECO_N_GENERIC_MODEL_LAI

• INSEASON_PRECO_N_GENERIC_MODEL_INVERSE_NDVI

• INSEASON_PRECO_N_GENERIC_MODEL_INVERSE_CVIN

• INSEASON_PRECO_N_GENERIC_MODEL_INVERSE_LAI

Authorizations:
oauth2
path Parameters
imageReference
required
string

Image reference using either the image date or the image id

nPlanned
required
number <float>

Dose of Nitrogen planned units depend on User profile. UK: kg / ha

mapType
required
string
Enum: "INSEASONCANOPY_N_REVERSE_LAI" "INSEASONFIELD_AVERAGE_LAI" "INSEASONFIELD_AVERAGE_NDVI" "INSEASONFIELD_AVERAGE_REVERSE_LAI" "INSEASONFIELD_AVERAGE_REVERSE_NDVI" "INSEASON_PRECO_N_GENERIC_MODEL_NDVI" "INSEASON_PRECO_N_GENERIC_MODEL_CVIN" "INSEASON_PRECO_N_GENERIC_MODEL_LAI" "INSEASON_PRECO_N_GENERIC_MODEL_INVERSE_NDVI" "INSEASON_PRECO_N_GENERIC_MODEL_INVERSE_CVIN" "INSEASON_PRECO_N_GENERIC_MODEL_INVERSE_LAI"
seasonFieldId
required
string

Season field id

query Parameters
gain
number <double>

This parameter allows to multiply a base reference map value with a constant gain factor. Default value : 1

offset
number <double>

This parameter allows to add a constant offset on the base reference map value. Default value : 0

nMax
number <float>

Maximum threshold for the N dose Minimum value allowed is 0. Maximum value allowed is 999.

nMin
number <float>

Minimum threshold for the N dose Minimum value allowed is 0. Maximum value allowed is 999.

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

OrganicMatterMap

maps/organic-matter-map/{mapType}

The Organic Matter Variability Map API allows to create an Organic Matter Variability map based on a field boundary, a crop, a sowing date, the average organic matter in the field and the image date (using the Archive coverage API).

The Organic Matter Variability Map is used to represent the relative organic matter distribution in the field (i.e. the nitrogen available within the soil).

This information is used by the grower during the establishment of the fertilization strategy, to plan and modulate the nitrogen fertilization

The result of the query will be an Organic Matter Variability map

This API is based on:

• Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• Map type

• Average organic matter for the field

This API retrieves:

• URLs to display the organic matter map in PNG, GEOTIFF, SHAPEFILE and KMZ formats, at 5 m resolution;

• URL to display the map thumbnail file as PNG format;

• URL to display the map legend in only available for PNG format;

• URL to display the world-file in PGW format to locate the map;

• URL to display the Notebook map as PNG format to locate the map on a Google maps background;

• URL to display the scalebar in PNG format;

• URL to recover The HotSpot points in Shapefile, KMZ and GML formats by zone or by segment;

• The Histogram values by classes;

Authorizations:
oauth2
path Parameters
mapType
required
string
Value: "OM"
query Parameters
thumbnailSize
integer <int32>

Enable to define size of thumbnail image (square shape)

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string
Request Body schema:
object (ImageReference)
averageOrganicMatter
number <float>
object (SeasonFieldReference)
name
string
tags
Array of strings
object

Responses

Request samples

Content type
{
  • "image": {
    },
  • "averageOrganicMatter": 0,
  • "seasonField": {
    },
  • "name": "string",
  • "tags": [
    ],
  • "externalIds": {
    }
}

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "tags": [
    ],
  • "externalIds": {
    },
  • "seasonField": {
    },
  • "_links": {
    },
  • "index": 0,
  • "hotSpots": [
    ],
  • "legend": {
    },
  • "zones": [
    ],
  • "histogram": {
    },
  • "date": "string",
  • "worldFile": {
    },
  • "mapSize": "string",
  • "bBox": {
    }
}

map-sets/organic-matter-map/{mapType}

This API allows to generate a set of several organic matter maps for a several fields or geometry derived satellite images.

This API is based on:

• Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• Map type

• Average organic matter for the field

This API retrieves:

• URLs to display the organic matter maps in PNG, GEOTIFF, SHAPEFILE and KMZ formats, at 5 m resolution;

• URL to display the map thumbnail file as PNG format;

• URL to display the map legend in only available for PNG format;

• URL to display the world-file in PGW format to locate the map;

• URL to display the Notebook map as PNG format to locate the map on a Google maps background;

• URL to display the scalebar in PNG format;

• URL to recover The HotSpot points in Shapefile, KMZ and GML formats by zone or by segment;

• The Histogram values by classes;

Authorizations:
oauth2
path Parameters
mapType
required
string
Value: "OM"
query Parameters
directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string
Request Body schema:
imageMimeType
string
Array of objects (OrganicMatterMapBodyParameters)

Responses

Request samples

Content type
{
  • "imageMimeType": "string",
  • "mapParams": [
    ]
}

Response samples

Content type
[
  • {
    }
]

season-fields/{seasonFieldId}/coverage/{imageReference}/organic-matter-map/{mapType}/averageOrganicMatter/{averageOrganicMatter}

This API allows to request Organic matter map by using shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The image date

• The map Type

• Average organic matter value

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map type is :

• OM

Authorizations:
oauth2
path Parameters
imageReference
required
string

Image reference using either the image date or the image id

averageOrganicMatter
required
number <float>
mapType
required
string
Value: "OM"
seasonFieldId
required
string

Season field id

query Parameters
thumbnailSize
integer <int32>

Enable to define size of thumbnail image (square shape)

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "tags": [
    ],
  • "externalIds": {
    },
  • "seasonField": {
    },
  • "_links": {
    },
  • "index": 0,
  • "hotSpots": [
    ],
  • "legend": {
    },
  • "zones": [
    ],
  • "histogram": {
    },
  • "date": "string",
  • "worldFile": {
    },
  • "mapSize": "string",
  • "bBox": {
    }
}

season-fields/{seasonFieldId}/coverage/{imageReference}/organic-matter-map/{mapType}/averageOrganicMatter/{averageOrganicMatter}/hotspot{extension}

This API allows you to request the file containing hotspots of the OM map by using shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• the image date reference

• The map Type

• The average organic matter value

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map type is :

• OM

Authorizations:
oauth2
path Parameters
imageReference
required
string

Image reference using either the image date or the image id

averageOrganicMatter
required
number <float>
mapType
required
string
Value: "OM"
seasonFieldId
required
string

Season field id

extension
required
string
Enum: ".kml" ".shp.zip" ".gml"
query Parameters
directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/coverage/{imageReference}/organic-matter-map/{mapType}/averageOrganicMatter/{averageOrganicMatter}/image{extension}

This API allows to request the organic matter map image by using Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• the image date reference

• The map Type

• Average organic matter value

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map type is :

• OM

The available extensions are:

• .shp.zip

• .tiff

• .kmz

• .png

Authorizations:
oauth2
path Parameters
imageReference
required
string

Image reference using either the image date or the image id

averageOrganicMatter
required
number <float>
mapType
required
string
Value: "OM"
seasonFieldId
required
string

Season field id

extension
required
string
Enum: ".png" ".tiff.zip" ".shp.zip" ".kmz"
query Parameters
directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/coverage/{imageReference}/organic-matter-map/{mapType}/averageOrganicMatter/{averageOrganicMatter}/legend.png

This API allows to request the organic matter map legend in PNG format by using by using Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• the image date reference

• The map Type

• Average organic matter value

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map type is :

• OM

Authorizations:
oauth2
path Parameters
imageReference
required
string

Image reference using either the image date or the image id

averageOrganicMatter
required
number <float>
mapType
required
string
Value: "OM"
seasonFieldId
required
string

Season field id

query Parameters
directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

Responses

season-fields/{seasonFieldId}/coverage/{imageReference}/organic-matter-map/{mapType}/averageOrganicMatter/{averageOrganicMatter}/notebook.png

This API allows to request the organic matter map Notebook in PNG format by using Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• the image date reference

• The map Type

• Average organic matter value

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map type is :

• OM

Authorizations:
oauth2
path Parameters
imageReference
required
string

Image reference using either the image date or the image id

averageOrganicMatter
required
number <float>
mapType
required
string
Value: "OM"
seasonFieldId
required
string

Season field id

query Parameters
directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/coverage/{imageReference}/organic-matter-map/{mapType}/averageOrganicMatter/{averageOrganicMatter}/scalebar.png

This API allows to request the organic matter map scalebar in PNG format by using Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• the image date reference

• The map Type

• Average organic matter value

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map type is :

• OM

Authorizations:
oauth2
path Parameters
imageReference
required
string

Image reference using either the image date or the image id

averageOrganicMatter
required
number <float>
mapType
required
string
Value: "OM"
seasonFieldId
required
string

Season field id

query Parameters
directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/coverage/{imageReference}/organic-matter-map/{mapType}/averageOrganicMatter/{averageOrganicMatter}/thumbnail.png

This API allows to request the organic matter map thumbnail in PNG format by using Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• the image date reference

• The map Type

• Average organic matter value

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map type is :

• OM

Authorizations:
oauth2
path Parameters
imageReference
required
string

Image reference using either the image date or the image id

averageOrganicMatter
required
number <float>
mapType
required
string
Value: "OM"
seasonFieldId
required
string

Season field id

query Parameters
thumbnailSize
integer <int32>

Enable to define size of thumbnail image (square shape)

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/coverage/{imageReference}/organic-matter-map/{mapType}/averageOrganicMatter/{averageOrganicMatter}/world-file.pgw

This API allows to request the world-file in PGW format to locate the Organic matter map with Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• the image date reference

• The map Type

• Average organic matter value

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map type is :

• OM

Authorizations:
oauth2
path Parameters
imageReference
required
string

Image reference using either the image date or the image id

averageOrganicMatter
required
number <float>
mapType
required
string
Value: "OM"
seasonFieldId
required
string

Season field id

query Parameters
directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

Reflectance

season-fields/{seasonFieldId}/coverage/{imageReference}/reflectance-map/{mapType}

This API allows to extract **the Top Of Canopy values ** for my field by using shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The image reference map identifier

• The map type

The map type is :

• TOC

The available extensions are:

• .tiff

Authorizations:
oauth2
path Parameters
imageReference
required
string
mapType
required
string
Value: "TOC"
seasonFieldId
required
string

Season field id

query Parameters
$epsg-out
integer <int32>

Output geometries projection code

header Parameters
headerParameters
string

Responses

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "tags": [
    ],
  • "externalIds": {
    },
  • "seasonField": {
    },
  • "_links": {
    },
  • "index": 0,
  • "legend": {
    },
  • "histogram": {
    },
  • "date": "string",
  • "worldFile": {
    },
  • "mapSize": "string",
  • "bBox": {
    }
}

season-fields/{seasonFieldId}/coverage/{imageReference}/reflectance-map/{mapType}/image.tiff.zip

This API allows to extract **the Top Of Canopy values ** for my field by using shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The image reference map identifier

• The map type

The map type is :

• TOC

The available extensions are:

• .tiff

Authorizations:
oauth2
path Parameters
imageReference
required
string
mapType
required
string
Value: "TOC"
seasonFieldId
required
string

Season field id

query Parameters
$epsg-out
integer <int32>

Output geometries projection code

header Parameters
headerParameters
string

Responses

RxMap

maps/{sourceMapId}/rx-map

This API allows to request Rx-maps by using [shortcuts] (https://geosys.stoplight.io/docs/field-level-maps-1/docs/02-overall.md) :

• The image identifier

Authorizations:
oauth2
path Parameters
sourceMapId
required
string

Identifier from the map on which you want to generate the rx

query Parameters
thumbnailSize
integer <int32>

Enable to define size of thumbnail image (square shape)

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "date": "string",
  • "tags": [
    ],
  • "mapType": "string",
  • "parameters": {
    },
  • "legend": {
    },
  • "creationDate": "2019-08-24T14:15:22Z",
  • "_links": {
    },
  • "outputParameters": {
    },
  • "hotSpots": [
    ],
  • "zones": [
    ],
  • "externalIds": {
    },
  • "histogram": {
    },
  • "worldFile": {
    },
  • "mapSize": {
    },
  • "bBox": {
    },
  • "version": 0
}

maps/{sourceMapId}/rx-map/image{extension}

This API allows to request Rx-maps image by using shortcuts:

• The image identifier

The available extensions are:

• .shp.zip

• .tiff.zip

• .kmz

• .png

GeosysThe API Design Management Platform powering the world's leading API first companies.geosys.stoplight.io

Authorizations:
oauth2
path Parameters
sourceMapId
required
string

Identifier from the map on which you want to generate the rx

extension
required
string
Enum: ".png" ".tiff.zip" ".shp.zip" ".kmz"
query Parameters
thumbnailSize
integer <int32>

Enable to define size of thumbnail image (square shape)

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

maps/{sourceMapId}/rx-map/legend.png

This API allows to request Rx-maps legend in PNG format by using Shortcuts :

• The image identifier\n

Authorizations:
oauth2
path Parameters
sourceMapId
required
string

Identifier from the map on which you want to generate the rx

query Parameters
thumbnailSize
integer <int32>

Enable to define size of thumbnail image (square shape)

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

Responses

maps/{sourceMapId}/rx-map/notebook.png

This API allows to request Rx-maps notebook in PNG format by using Shortcuts

Authorizations:
oauth2
path Parameters
sourceMapId
required
string

Identifier from the map on which you want to generate the rx

extension
required
string
Enum: ".png" ".tiff.zip" ".shp.zip" ".kmz"
query Parameters
thumbnailSize
integer <int32>

Enable to define size of thumbnail image (square shape)

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

maps/{sourceMapId}/rx-map/scalebar.png

The Rx-maps scalebar by using Shortcuts :

• The image identifier

• The extension\n

Authorizations:
oauth2
path Parameters
sourceMapId
required
string

Identifier from the map on which you want to generate the rx

extension
required
string
Enum: ".png" ".tiff.zip" ".shp.zip" ".kmz"
query Parameters
thumbnailSize
integer <int32>

Enable to define size of thumbnail image (square shape)

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

maps/{sourceMapId}/rx-map/thumbnail.png

The Rx-maps thumbnail by using Shortcuts :

• The image identifier

• The extension\n

Authorizations:
oauth2
path Parameters
sourceMapId
required
string

Identifier from the map on which you want to generate the rx

query Parameters
thumbnailSize
integer <int32>

Enable to define size of thumbnail image (square shape)

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

Responses

maps/{sourceMapId}/rx-map/world-file.pgw

The Rx-maps world file by using Shortcuts :

• The image identifier

• The extension\n

Authorizations:
oauth2
path Parameters
sourceMapId
required
string

Identifier from the map on which you want to generate the rx

query Parameters
thumbnailSize
integer <int32>

Enable to define size of thumbnail image (square shape)

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

maps/rx-map

This API allows to generate variable-rate prescription "Rx" Maps, based on source map type to generate a zonal map.

The zone map can be customize: Rx type and product to be applied, number of zones, zone geometries, product placement, and choose rates per zone.

The source map can be :

• Base reference map with Clear coverage.

• Yield potential map and extension (YPM/YVM/YGM)

• SAMZ map

• Elevation Map

This API is based on:

• Map source

This API retrieves:

• URLs to display the Rx map in PNG, GEOTIFF, SHAPEFILE and KMZ formats, at 5 m resolution;

• URL to display the map thumbnail file as PNG format;

• URL to display the map legend in only available for PNG format;

• URL to display the world-file in PGW format to locate the map;

• URL to display the Notebook map as PNG format to locate the map on a Google maps background;

• URL to display the scalebar in PNG format;

• The Histogram values by classes;

Authorizations:
oauth2
query Parameters
$epsg-out
integer <int32>

Output geometries projection code

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

header Parameters
headerParameters
string
Request Body schema:
sourceMapId
string
zoneCount
integer <int32>
Array of objects (RxZone)
object
object (SeasonFieldReference)
name
string
tags
Array of strings
object

Responses

Request samples

Content type
{
  • "sourceMapId": "string",
  • "zoneCount": 0,
  • "zones": [
    ],
  • "properties": {
    },
  • "seasonField": {
    },
  • "name": "string",
  • "tags": [
    ],
  • "externalIds": {
    }
}

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "date": "string",
  • "tags": [
    ],
  • "mapType": "string",
  • "parameters": {
    },
  • "legend": {
    },
  • "creationDate": "2019-08-24T14:15:22Z",
  • "_links": {
    },
  • "outputParameters": {
    },
  • "hotSpots": [
    ],
  • "zones": [
    ],
  • "externalIds": {
    },
  • "histogram": {
    },
  • "worldFile": {
    },
  • "mapSize": {
    },
  • "bBox": {
    },
  • "version": 0
}

SampleMap

maps/sample/samplemap

This API allows to generate sample maps based on soil provider (SURGGO for the US)

This API is based on:

• Season field identifier

This API retrieves:

• URLs to display Sample map in PNG, GEOTIFF, SHAPEFILE and KMZ formats, at 5 m resolution;

• URL to display the map thumbnail file as PNG format;

• URL to display the map legend in only available for PNG format;

• URL to display the world-file in PGW format to locate the map;

• URL to display the Notebook map as PNG format to locate the map on a Google maps background;

• URL to display the scalebar in PNG format;

Authorizations:
oauth2
query Parameters
$epsg-out
integer <int32>

Output geometries projection code

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

header Parameters
headerParameters
string
Request Body schema:
Array of objects (SampleMapPointContract)
object
object (SeasonFieldReference)
name
string
tags
Array of strings
object

Responses

Request samples

Content type
{
  • "data": [
    ],
  • "properties": {
    },
  • "seasonField": {
    },
  • "name": "string",
  • "tags": [
    ],
  • "externalIds": {
    }
}

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "tags": [
    ],
  • "externalIds": {
    },
  • "seasonField": {
    },
  • "_links": {
    },
  • "index": 0,
  • "hotSpots": [
    ],
  • "legend": {
    },
  • "zones": [
    ],
  • "histogram": {
    },
  • "date": "string",
  • "worldFile": {
    },
  • "mapSize": "string",
  • "bBox": {
    }
}

SamzMap

maps/management-zones-map/{mapType}

This API allows to display a management zone map for a field or a geometry (optionally based on Coverage API).

This API is based on:

• Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• Image dates (optional)

• Zone number

This API retrieves:

• URLs to display the Management zone map in PNG, GEOTIFF, Shapefile and KMZ formats, at 5 m resolution

• URL to display the map thumbnail file as PNG format

• URL to display the map legend in only available for PNG format

• URL to display the world-file in PGW format to locate the map

• URL to display the Notebook map as PNG format to locate the map on a Google maps background;

• URL to display the scalebar in PNG format;

• The Histogram values by classes;

Two zone creation methods are currently available:

• Standard: When image dates are not defined in the request, Geosys Platform will automatically select in the coverage:

o 2 wet images o 2 dry images o the last one bare soil image.

• Custom: When image dates are including in the request, management zone creation will use only selected images. This allows to specialize management zone creation with a specific business logic: only peak vegetation, only specific year.

Authorizations:
oauth2
path Parameters
mapType
required
string
Value: "SAMZ"
query Parameters
thumbnailSize
integer <int32>

Enable to define size of thumbnail image (square shape)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string
Request Body schema:
Array of objects (ImageReference)
maxZoneSize
number <double>
object (SeasonFieldReference)
name
string
tags
Array of strings
object

Responses

Request samples

Content type
{
  • "images": [
    ],
  • "maxZoneSize": 0,
  • "seasonField": {
    },
  • "name": "string",
  • "tags": [
    ],
  • "externalIds": {
    }
}

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "tags": [
    ],
  • "externalIds": {
    },
  • "seasonField": {
    },
  • "_links": {
    },
  • "index": 0,
  • "hotSpots": [
    ],
  • "legend": {
    },
  • "zones": [
    ],
  • "histogram": {
    },
  • "date": "string",
  • "worldFile": {
    },
  • "mapSize": "string",
  • "bBox": {
    }
}

map-sets/management-zones-map/{mapType}

This API allows to display a set of several management zone maps from fields and their geometry (optionally based on Coverage API).

This API is based on:

• Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• Image dates (optional)

• Zone number

This API retrieves:

• URLs to display the Management zone maps in PNG, GEOTIFF, Shapefile and KMZ formats, at 5 m resolution

• URL to display the map thumbnail file as PNG format

• URL to display the map legend in only available for PNG format

• URL to display the world-file in PGW format to locate the map

• URL to display the Notebook map as PNG format to locate the map on a Google maps background;

• URL to display the scalebar in PNG format;

• The Histogram values by classes;

Two zone creation methods are currently available:

• Standard: When image dates are not defined in the request, Geosys Platform will automatically select in the coverage:

o 2 wet images o 2 dry images o the last one bare soil image.

• Custom: When image dates are including in the request, management zone creation will use only selected images. This allows to specialize management zone creation with a specific business logic: only peak vegetation, only specific year.

Authorizations:
oauth2
path Parameters
mapType
required
string
Value: "SAMZ"
query Parameters
colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string
Request Body schema:
imageMimeType
string
Array of objects (SamzMapBodyParameters)

Responses

Request samples

Content type
{
  • "imageMimeType": "string",
  • "mapParams": [
    ]
}

Response samples

Content type
[
  • {
    }
]

season-fields/{seasonFieldId}/management-zones-map/{mapType}

This API allows to request Management zones map by using shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The map type

The map type is :

• SAMZ

Authorizations:
oauth2
path Parameters
mapType
required
string
Value: "SAMZ"
seasonFieldId
required
string

Season field id

query Parameters
imageReferences
Array of strings
maxZoneSize
number <double>
colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "tags": [
    ],
  • "externalIds": {
    },
  • "seasonField": {
    },
  • "_links": {
    },
  • "index": 0,
  • "hotSpots": [
    ],
  • "legend": {
    },
  • "zones": [
    ],
  • "histogram": {
    },
  • "date": "string",
  • "worldFile": {
    },
  • "mapSize": "string",
  • "bBox": {
    }
}

season-fields/{seasonFieldId}/management-zones-map/{mapType}/image{extension}

This API allows to request the management zones image by using Shortcuts :• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The map type

The map type is :

• SAMZ

The available extensions are:

• .shp.zip

• .tiff

• .kmz

• .png

Authorizations:
oauth2
path Parameters
mapType
required
string
Value: "SAMZ"
seasonFieldId
required
string

Season field id

extension
required
string
Enum: ".png" ".tiff.zip" ".shp.zip" ".kmz"
query Parameters
imageReferences
Array of strings
maxZoneSize
number <double>
colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/management-zones-map/{mapType}/legend.png

This API allows to request the Management zones map legend in PNG format by using by using Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The map type

The map type is :

• SAMZ

Authorizations:
oauth2
path Parameters
mapType
required
string
Value: "SAMZ"
seasonFieldId
required
string

Season field id

query Parameters
imageReferences
Array of strings
maxZoneSize
number <double>
colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

Responses

season-fields/{seasonFieldId}/management-zones-map/{mapType}/notebook.png

This API allows to request the management zones map Notebook in PNG format by using Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The map type

The map type is :

• SAMZ

Authorizations:
oauth2
path Parameters
mapType
required
string
Value: "SAMZ"
seasonFieldId
required
string

Season field id

query Parameters
imageReferences
Array of strings
maxZoneSize
number <double>
colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/management-zones-map/{mapType}/scalebar.png

This API allows to request the Management zones scalebar in PNG format by using Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The map type

The map type is :

• SAMZ

Authorizations:
oauth2
path Parameters
mapType
required
string
Value: "SAMZ"
seasonFieldId
required
string

Season field id

query Parameters
imageReferences
Array of strings
maxZoneSize
number <double>
colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/management-zones-map/{mapType}/thumbnail.png

This API allows to request the Management zones map thumbnail in PNG format by using Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The map type

The map type is :

• SAMZ

Authorizations:
oauth2
path Parameters
mapType
required
string
Value: "SAMZ"
seasonFieldId
required
string

Season field id

query Parameters
thumbnailSize
integer <int32>
imageReferences
Array of strings
maxZoneSize
number <double>
colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

Responses

season-fields/{seasonFieldId}/management-zones-map/{mapType}/world-file.pgw

This API allows to request the world-file in PGW format to locate the management zones map with Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The map type

The map type is :

• SAMZ

Authorizations:
oauth2
path Parameters
mapType
required
string
Value: "SAMZ"
seasonFieldId
required
string

Season field id

query Parameters
imageReferences
Array of strings
maxZoneSize
number <double>
colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

SoilMap

maps/sample/soilmap

Authorizations:
oauth2
query Parameters
$epsg-out
integer <int32>

Output geometries projection code

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string
Request Body schema:
provider
string
asset
string
object (SeasonFieldReference)
name
string
tags
Array of strings
object

Responses

Request samples

Content type
{
  • "provider": "string",
  • "asset": "string",
  • "seasonField": {
    },
  • "name": "string",
  • "tags": [
    ],
  • "externalIds": {
    }
}

Response samples

Content type
{
  • "zones": [
    ],
  • "hotSpots": [
    ],
  • "legend": {
    },
  • "name": "string",
  • "tags": [
    ],
  • "id": "string",
  • "seasonField": {
    },
  • "links": {
    },
  • "index": 0,
  • "histogram": {
    },
  • "date": "string",
  • "externalIds": {
    }
}

season-fields/{seasonFieldId}/sample/{mapType}/Shared/USA

This API allows to request Sample map by using shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The map Type

The map types are :

• Soilmap

• Samplemap

Authorizations:
oauth2
path Parameters
mapType
required
string
Enum: "SOILMAP" "SAMPLEMAP"
provider
required
string
asset
required
string
seasonFieldId
required
string

Season field id

query Parameters
$epsg-out
integer <int32>

Output geometries projection code

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

Response samples

Content type
{
  • "zones": [
    ],
  • "hotSpots": [
    ],
  • "legend": {
    },
  • "name": "string",
  • "tags": [
    ],
  • "id": "string",
  • "seasonField": {
    },
  • "links": {
    },
  • "index": 0,
  • "histogram": {
    },
  • "date": "string",
  • "externalIds": {
    }
}

season-fields/{seasonFieldId}/sample/{mapType}/Shared/USA/image{extension}

This API allows to request the Sample image by using Shortcuts:

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The map Type

The map types are :

• Soilmap

• Samplemap

The available extensions are:

• .shp.zip

• .tiff

• .kmz

• .png

Authorizations:
oauth2
path Parameters
mapType
required
string
Enum: "SOILMAP" "SAMPLEMAP"
provider
required
string
asset
required
string
seasonFieldId
required
string

Season field id

extension
required
string
Enum: ".png" ".tiff.zip" ".shp.zip" ".kmz"
query Parameters
$epsg-out
integer <int32>

Output geometries projection code

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/sample/{mapType}/Shared/USA/legend.png

This API allows to request the Sample map legend in PNG format by using by using Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The map Type

The map types are :

• Soilmap

• Samplemap

Authorizations:
oauth2
path Parameters
mapType
required
string
Enum: "SOILMAP" "SAMPLEMAP"
provider
required
string
asset
required
string
seasonFieldId
required
string

Season field id

query Parameters
$epsg-out
integer <int32>

Output geometries projection code

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/sample/{mapType}/Shared/USA/notebook.png

This API allows to request the Sample map Notebook in PNG format by using Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The map Type

The map types are :

• Soilmap

• Samplemap

Authorizations:
oauth2
path Parameters
mapType
required
string
Enum: "SOILMAP" "SAMPLEMAP"
provider
required
string
asset
required
string
seasonFieldId
required
string

Season field id

query Parameters
$epsg-out
integer <int32>

Output geometries projection code

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/sample/{mapType}/Shared/USA/scalebar.png

This API allows to request the Sample map scalebar in PNG format by using Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The map Type

The map types are :

• Soilmap

• Samplemap

Authorizations:
oauth2
path Parameters
mapType
required
string
Enum: "SOILMAP" "SAMPLEMAP"
provider
required
string
asset
required
string
seasonFieldId
required
string

Season field id

query Parameters
$epsg-out
integer <int32>

Output geometries projection code

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/sample/{mapType}/Shared/USA/thumbnail.png

This API allows to request the Sample map thumbnail in PNG format by using Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The map Type

The map types are :

• Soilmap

• Samplemap

Authorizations:
oauth2
path Parameters
mapType
required
string
Enum: "SOILMAP" "SAMPLEMAP"
provider
required
string
asset
required
string
seasonFieldId
required
string

Season field id

query Parameters
thumbnailSize
integer <int32>

Enable to define size of thumbnail image (square shape)

$epsg-out
integer <int32>

Output geometries projection code

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/sample/{mapType}/Shared/USA/world-file.pgw

This API allows to request the world-file in PGW format to locate the Sample map with Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The map Type

The map types are :

• Soilmap

• Samplemap

Authorizations:
oauth2
path Parameters
mapType
required
string
Enum: "SOILMAP" "SAMPLEMAP"
provider
required
string
asset
required
string
seasonFieldId
required
string

Season field id

query Parameters
$epsg-out
integer <int32>

Output geometries projection code

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

TopologyMap

maps/topology-map/{mapType}

This API allows to generate topology maps for a field or a geometry derived from digital elevation data:

• Elevation map highlighting altitude variability of the field

• Slope map highlighting steepness of the slope (this is not the direction)

This API is based on:

• Season Field Identifiers (GEOSYS ID and/or Customer External ID)

This API retrieves:

• URLs to display topology map in PNG, GEOTIFF, Shapefile and KMZ formats, at 5 m resolution;

• URL to display the map thumbnail file as PNG format;

• URL to display the map legend in only available for PNG format;

• URL to display the world-file in PGW format to locate the map;

• URL to display the Notebook map as PNG format to locate the map on a background Google maps ;

• URL to display the scalebar in PNG format;

• URL to recover The HotSpot points in Shapefile, KMZ and GML formats by zone or by segment;

• The Histogram values by classes;

Authorizations:
oauth2
path Parameters
mapType
required
string
Enum: "ELEVATION" "EROSION" "SLOPE"
query Parameters
thumbnailSize
integer <int32>

Enable to define size of thumbnail image (square shape)

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string
Request Body schema:
object (SeasonFieldReference)
name
string
tags
Array of strings
object

Responses

Request samples

Content type
{
  • "seasonField": {
    },
  • "name": "string",
  • "tags": [
    ],
  • "externalIds": {
    }
}

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "tags": [
    ],
  • "externalIds": {
    },
  • "seasonField": {
    },
  • "_links": {
    },
  • "index": 0,
  • "hotSpots": [
    ],
  • "legend": {
    },
  • "zones": [
    ],
  • "histogram": {
    },
  • "date": "string",
  • "worldFile": {
    },
  • "mapSize": "string",
  • "bBox": {
    }
}

map-sets/topology-map/{mapType}

This API allows to generate a set of several topology maps.

This API is based on:

• Seasons Fields Identifiers (GEOSYS ID and/or Customer External ID)

This API retrieves:

• URLs to display topology maps in PNG, GEOTIFF, Shapefile and KMZ formats, at 5 m resolution;

• URL to display the map thumbnail file as PNG format;

• URL to display the map legend in only available for PNG format;

• URL to display the world-file in PGW format to locate the map;

• URL to display the Notebook map as PNG format to locate the map on a background Google maps ;

• URL to display the scalebar in PNG format;

• URL to recover The HotSpot points in Shapefile, KMZ and GML formats by zone or by segment;

• The Histogram values by classes;

Authorizations:
oauth2
path Parameters
mapType
required
string
Enum: "ELEVATION" "EROSION" "SLOPE"
query Parameters
directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string
Request Body schema:
imageMimeType
string
Array of objects (TopologyMapsBodyParameters)

Responses

Request samples

Content type
{
  • "imageMimeType": "string",
  • "mapParams": [
    ]
}

Response samples

Content type
[
  • {
    }
]

season-fields/{seasonFieldId}/topology-map/{mapType}

This API allows to request Topology map by using shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The map type

The map type is :

• Elevation

• Erosion

• Slope

Authorizations:
oauth2
path Parameters
mapType
required
string
Enum: "ELEVATION" "EROSION" "SLOPE"
seasonFieldId
required
string

Season field id

query Parameters
thumbnailSize
integer <int32>

Enable to define size of thumbnail image (square shape)

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "tags": [
    ],
  • "externalIds": {
    },
  • "seasonField": {
    },
  • "_links": {
    },
  • "index": 0,
  • "hotSpots": [
    ],
  • "legend": {
    },
  • "zones": [
    ],
  • "histogram": {
    },
  • "date": "string",
  • "worldFile": {
    },
  • "mapSize": "string",
  • "bBox": {
    }
}

season-fields/{seasonFieldId}/topology-map/{mapType}/image{extension}

This API allows to request Topology map by using shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The map type

The map type is :

• Elevation

• Erosion

• Slope

The available extensions are:

• .shp.zip

• .tiff

• .kmz

• .png

Authorizations:
oauth2
path Parameters
extension
required
string
Enum: ".png" ".tiff.zip" ".shp.zip" ".kmz"
mapType
required
string
Enum: "ELEVATION" "EROSION" "SLOPE"
seasonFieldId
required
string

Season field id

query Parameters
directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/topology-map/{mapType}/legend.png

This API allows to request the Topology map legend in PNG format by using by using Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The map type

The map type is :

• Elevation

• Erosion

• Slope

Authorizations:
oauth2
path Parameters
mapType
required
string
Enum: "ELEVATION" "EROSION" "SLOPE"
seasonFieldId
required
string

Season field id

query Parameters
directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

Responses

season-fields/{seasonFieldId}/topology-map/{mapType}/notebook.png

Authorizations:
oauth2
path Parameters
mapType
required
string
Enum: "ELEVATION" "EROSION" "SLOPE"
seasonFieldId
required
string

Season field id

extension
required
string
Enum: ".png" ".tiff.zip" ".shp.zip" ".kmz"
query Parameters
directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

Responses

season-fields/{seasonFieldId}/topology-map/{mapType}/scalebar.png

Authorizations:
oauth2
path Parameters
mapType
required
string
Enum: "ELEVATION" "EROSION" "SLOPE"
seasonFieldId
required
string

Season field id

extension
required
string
Enum: ".png" ".tiff.zip" ".shp.zip" ".kmz"
query Parameters
directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

Responses

season-fields/{seasonFieldId}/topology-map/{mapType}/thumbnail.png

This API allows to request the Topology map thumbnail in PNG format by using Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The map type

The map type is :

• Elevation

• Erosion

• Slope

Authorizations:
oauth2
path Parameters
mapType
required
string
Enum: "ELEVATION" "EROSION" "SLOPE"
seasonFieldId
required
string

Season field id

query Parameters
thumbnailSize
integer <int32>

Enable to define size of thumbnail image (square shape)

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

Responses

season-fields/{seasonFieldId}/topology-map/{mapType}/world-file.pgw

This API allows to request the world-file in PGW format to locate the Topology map with Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The map type

The map type is :

• Elevation

• Erosion

• Slope

Authorizations:
oauth2
path Parameters
mapType
required
string
Enum: "ELEVATION" "EROSION" "SLOPE"
seasonFieldId
required
string

Season field id

query Parameters
directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

YieldGoalMap

maps/yield-goal-map/{mapType}

The Yield Goal Map API allows to create a Yield Goal Map based on a field boundary, a crop, a sowing date, the historical yield average, and the image date and the minimum and maximum yield values.

This API is based on:

• Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• Map type

• Historical yield average (Min 0, Max 999 (without unit))

• Image date of the archive image (the Coverage APIs or the catalog imagery APIs.)

• Minimum yield value – Mandatory value; Min 0, Max 999 (without unit)

• Maximum yield value – Mandatory value ; Min 0, Max 999 (without unit)

This API retrieves:

• URLs to display YGM map in PNG, GEOTIFF, Shapefile and KMZ formats, at 5 m resolution;

• URL to display the map thumbnail file as PNG format;

• URL to display the map legend in only available for PNG format;

• URL to display the world-file in PGW format to locate the map;

• URL to display the Notebook map as PNG format to locate the map on a background Google maps ;

• URL to display the scalebar in PNG format;

• URL to recover The HotSpot points in Shapefile, KMZ and GML formats by zone or by segment;

• The Histogram values by classes;

Authorizations:
oauth2
path Parameters
mapType
required
string
Value: "YGM"
query Parameters
thumbnailSize
integer <int32>

Enable to define size of thumbnail image (square shape)

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string
Request Body schema:
object (ImageReference)
minYieldGoal
number <float>
maxYieldGoal
number <float>
historicalYieldAverage
number <float>
object (SeasonFieldReference)
name
string
tags
Array of strings
object

Responses

Request samples

Content type
{
  • "image": {
    },
  • "minYieldGoal": 0,
  • "maxYieldGoal": 0,
  • "historicalYieldAverage": 0,
  • "seasonField": {
    },
  • "name": "string",
  • "tags": [
    ],
  • "externalIds": {
    }
}

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "tags": [
    ],
  • "externalIds": {
    },
  • "seasonField": {
    },
  • "_links": {
    },
  • "index": 0,
  • "hotSpots": [
    ],
  • "legend": {
    },
  • "zones": [
    ],
  • "histogram": {
    },
  • "date": "string",
  • "worldFile": {
    },
  • "mapSize": "string",
  • "bBox": {
    }
}

map-sets/yield-goal-map/{mapType}

This API allows to generate a set of several yield goal maps.

This API is based on:

• Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• Image date

• Min yield goal

• Max yield goal

• The historical yield average

This API retrieves:

• URLs to display YGM maps in PNG, GEOTIFF, Shapefile and KMZ formats, at 5 m resolution;

• URL to display the map thumbnail file as PNG format;

• URL to display the map legend in only available for PNG format;

• URL to display the world-file in PGW format to locate the map;

• URL to display the Notebook map as PNG format to locate the map on a background Google maps ;

• URL to display the scalebar in PNG format;

• URL to recover The HotSpot points in Shapefile, KMZ and GML formats by zone or by segment;

• The Histogram values by classes;

Authorizations:
oauth2
path Parameters
mapType
required
string
Value: "YGM"
query Parameters
directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string
Request Body schema:
imageMimeType
string
Array of objects (YieldGoalMapBodyParameters)

Responses

Request samples

Content type
{
  • "imageMimeType": "string",
  • "mapParams": [
    ]
}

Response samples

Content type
[
  • {
    }
]

season-fields/{seasonFieldId}/coverage/{imageReference}/yield-goal-map/{mapType}/historical-yield-average/{historicalYieldAverage}/max-yield-Goal/{maxYieldGoal}/min-yield-Goal/{minYieldGoal}

This API allows to request Yield goald map by using shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The image date

• The map Type

• Historical yield average – Min 0, Max 999 (without unit)

• Minimum yield value – Mandatory value; Min 0, Max 999 (without unit)

• Maximum yield value – Mandatory value ; Min 0, Max 999 (without unit)

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map type is :

• YGM

Authorizations:
oauth2
path Parameters
imageReference
required
string

Image reference using either the image date or the image id

minYieldGoal
required
number <float>
maxYieldGoal
required
number <float>
historicalYieldAverage
required
number <float>
mapType
required
string
Value: "YGM"
seasonFieldId
required
string

Season field id

query Parameters
thumbnailSize
integer <int32>

Enable to define size of thumbnail image (square shape)

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "tags": [
    ],
  • "externalIds": {
    },
  • "seasonField": {
    },
  • "_links": {
    },
  • "index": 0,
  • "hotSpots": [
    ],
  • "legend": {
    },
  • "zones": [
    ],
  • "histogram": {
    },
  • "date": "string",
  • "worldFile": {
    },
  • "mapSize": "string",
  • "bBox": {
    }
}

season-fields/{seasonFieldId}/coverage/{imageReference}/yield-goal-map/{mapType}/historical-yield-average/{historicalYieldAverage}/max-yield-Goal/{maxYieldGoal}/min-yield-Goal/{minYieldGoal}/hotspot{extension}

This API allows you to request the file containing hotspots of the YGM map by using shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The image date

• The map Type

• Historical yield average – Min 0, Max 999 (without unit)

• Minimum yield value – Mandatory value; Min 0, Max 999 (without unit)

• Maximum yield value – Mandatory value ; Min 0, Max 999 (without unit)

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map type is :

• YPM

Authorizations:
oauth2
path Parameters
imageReference
required
string

Image reference using either the image date or the image id

minYieldGoal
required
number <float>
maxYieldGoal
required
number <float>
historicalYieldAverage
required
number <float>
mapType
required
string
Value: "YGM"
seasonFieldId
required
string

Season field id

extension
required
string
Enum: ".kml" ".shp.zip" ".gml"
query Parameters
directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/coverage/{imageReference}/yield-goal-map/{mapType}/historical-yield-average/{historicalYieldAverage}/max-yield-Goal/{maxYieldGoal}/min-yield-Goal/{minYieldGoal}/image{extension}

This API allows to request the Yield Goal map image by using Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The image date

• The map Type

• Historical yield average – Min 0, Max 999 (without unit)

• Minimum yield value – Mandatory value; Min 0, Max 999 (without unit)

• Maximum yield value – Mandatory value ; Min 0, Max 999 (without unit)

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map type are :

• YGM

The available extensions are:

• .shp.zip

• .tiff

• .kmz

• .png

Authorizations:
oauth2
path Parameters
imageReference
required
string

Image reference using either the image date or the image id

minYieldGoal
required
number <float>
maxYieldGoal
required
number <float>
historicalYieldAverage
required
number <float>
mapType
required
string
Value: "YGM"
seasonFieldId
required
string

Season field id

extension
required
string
Enum: ".png" ".tiff.zip" ".shp.zip" ".kmz"
query Parameters
directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/coverage/{imageReference}/yield-goal-map/{mapType}/historical-yield-average/{historicalYieldAverage}/max-yield-Goal/{maxYieldGoal}/min-yield-Goal/{minYieldGoal}/legend.png

This API allows to request the yield goal map legend in PNG format by using by using Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The image date

• The map Type

• Historical yield average – Min 0, Max 999 (without unit)

• Minimum yield value – Mandatory value; Min 0, Max 999 (without unit)

• Maximum yield value – Mandatory value ; Min 0, Max 999 (without unit)

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map type are :

• YGM

Authorizations:
oauth2
path Parameters
imageReference
required
string

Image reference using either the image date or the image id

minYieldGoal
required
number <float>
maxYieldGoal
required
number <float>
historicalYieldAverage
required
number <float>
mapType
required
string
Value: "YGM"
seasonFieldId
required
string

Season field id

query Parameters
directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

Responses

season-fields/{seasonFieldId}/coverage/{imageReference}/yield-goal-map/{mapType}/historical-yield-average/{historicalYieldAverage}/max-yield-Goal/{maxYieldGoal}/min-yield-Goal/{minYieldGoal}/notebook.png

This API allows to request the yield goal map Notebook in PNG format by using Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The image date

• The map Type

• Historical yield average – Min 0, Max 999 (without unit)

• Minimum yield value – Mandatory value; Min 0, Max 999 (without unit)

• Maximum yield value – Mandatory value ; Min 0, Max 999 (without unit)

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map type are :

• YGM

Authorizations:
oauth2
path Parameters
imageReference
required
string

Image reference using either the image date or the image id

minYieldGoal
required
number <float>
maxYieldGoal
required
number <float>
historicalYieldAverage
required
number <float>
mapType
required
string
Value: "YGM"
seasonFieldId
required
string

Season field id

query Parameters
directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/coverage/{imageReference}/yield-goal-map/{mapType}/historical-yield-average/{historicalYieldAverage}/max-yield-Goal/{maxYieldGoal}/min-yield-Goal/{minYieldGoal}/scalebar.png

This API allows to request the yiel goal map scalebar in PNG format by using Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The image date

• The map Type

• Historical yield average – Min 0, Max 999 (without unit)

• Minimum yield value – Mandatory value; Min 0, Max 999 (without unit)

• Maximum yield value – Mandatory value ; Min 0, Max 999 (without unit)

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map type are :

• YGM

Authorizations:
oauth2
path Parameters
imageReference
required
string

Image reference using either the image date or the image id

minYieldGoal
required
number <float>
maxYieldGoal
required
number <float>
historicalYieldAverage
required
number <float>
mapType
required
string
Value: "YGM"
seasonFieldId
required
string

Season field id

query Parameters
directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/coverage/{imageReference}/yield-goal-map/{mapType}/historical-yield-average/{historicalYieldAverage}/max-yield-Goal/{maxYieldGoal}/min-yield-Goal/{minYieldGoal}/thumbnail.png

This API allows to request the yield goal map thumbnail in PNG format by using Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The image date

• The map Type

• Historical yield average – Min 0, Max 999 (without unit)

• Minimum yield value – Mandatory value; Min 0, Max 999 (without unit)

• Maximum yield value – Mandatory value ; Min 0, Max 999 (without unit)

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map type are :

• YGM

Authorizations:
oauth2
path Parameters
imageReference
required
string

Image reference using either the image date or the image id

minYieldGoal
required
number <float>
maxYieldGoal
required
number <float>
historicalYieldAverage
required
number <float>
mapType
required
string
Value: "YGM"
seasonFieldId
required
string

Season field id

query Parameters
thumbnailSize
integer <int32>

Enable to define size of thumbnail image (square shape)

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/coverage/{imageReference}/yield-goal-map/{mapType}/historical-yield-average/{historicalYieldAverage}/max-yield-Goal/{maxYieldGoal}/min-yield-Goal/{minYieldGoal}/world-file.pgw

This API allows to request the world-file in PGW format to locate the Yield goal map with Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The image date

• The map Type

• Historical yield average – Min 0, Max 999 (without unit)

• Minimum yield value – Mandatory value; Min 0, Max 999 (without unit)

• Maximum yield value – Mandatory value ; Min 0, Max 999 (without unit)

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map type are :

• YGM

Authorizations:
oauth2
path Parameters
imageReference
required
string

Image reference using either the image date or the image id

minYieldGoal
required
number <float>
maxYieldGoal
required
number <float>
historicalYieldAverage
required
number <float>
mapType
required
string
Value: "YGM"
seasonFieldId
required
string

Season field id

query Parameters
directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

YieldMap

maps/telemetry/{mapType}/private

This API allows to create a Yield map based on telemetry dataset (Use the Import yield API to recover the dataset).

This API is based on:

• Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• Harvest date

This API retrieves:

• URLs to display telemetry map in PNG, GEOTIFF, Shapefile and KMZ formats, at 5 m resolution;

• URL to display the map thumbnail file as PNG format;

• URL to display the map legend in only available for PNG format;

• URL to display the world-file in PGW format to locate the map;

• URL to display the Notebook map as PNG format to locate the map on a background Google maps ;

• URL to display the scalebar in PNG format;

• URL to recover The HotSpot points in Shapefile, KMZ and GML formats by zone or by segment;

• The Histogram values by classes;

Authorizations:
oauth2
path Parameters
mapType
required
string
Value: "YIM"
query Parameters
thumbnailSize
integer <int32>

Enable to define size of thumbnail image (square shape)

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string
Request Body schema:
date
string
parameter
string
object (SeasonFieldReference)
name
string
tags
Array of strings
object

Responses

Request samples

Content type
{
  • "date": "string",
  • "parameter": "string",
  • "seasonField": {
    },
  • "name": "string",
  • "tags": [
    ],
  • "externalIds": {
    }
}

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "tags": [
    ],
  • "externalIds": {
    },
  • "seasonField": {
    },
  • "_links": {
    },
  • "index": 0,
  • "hotSpots": [
    ],
  • "legend": {
    },
  • "zones": [
    ],
  • "histogram": {
    },
  • "date": "string",
  • "worldFile": {
    },
  • "mapSize": "string",
  • "bBox": {
    }
}

map-sets/telemetry/{mapType}/private

This API allows to create a set of several Yield maps.

This API is based on:

• Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• Harvest date

This API retrieves:

• URLs to display telemetry maps in PNG, GEOTIFF, Shapefile and KMZ formats, at 5 m resolution;

• URL to display the map thumbnail file as PNG format;

• URL to display the map legend in only available for PNG format;

• URL to display the world-file in PGW format to locate the map;

• URL to display the Notebook map as PNG format to locate the map on a background Google maps ;

• URL to display the scalebar in PNG format;

• URL to recover The HotSpot points in Shapefile, KMZ and GML formats by zone or by segment;

• The Histogram values by classes;

Authorizations:
oauth2
path Parameters
mapType
required
string
Value: "YIM"
query Parameters
directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string
Request Body schema:
imageMimeType
string
Array of objects (YieldMapBodyParameters)

Responses

Request samples

Content type
{
  • "imageMimeType": "string",
  • "mapParams": [
    ]
}

Response samples

Content type
[
  • {
    }
]

season-fields/{seasonFieldId}/telemetry/{date}/{mapType}/private/{parameter}

Authorizations:
oauth2
path Parameters
date
required
string
mapType
required
string
Value: "YIM"
parameter
required
string
seasonFieldId
required
string

Season field id

query Parameters
thumbnailSize
integer <int32>

Enable to define size of thumbnail image (square shape)

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "tags": [
    ],
  • "externalIds": {
    },
  • "seasonField": {
    },
  • "_links": {
    },
  • "index": 0,
  • "hotSpots": [
    ],
  • "legend": {
    },
  • "zones": [
    ],
  • "histogram": {
    },
  • "date": "string",
  • "worldFile": {
    },
  • "mapSize": "string",
  • "bBox": {
    }
}

season-fields/{seasonFieldId}/telemetry/{date}/{mapType}/private/{parameter}/hotspot{extension}

Authorizations:
oauth2
path Parameters
date
required
string
mapType
required
string
Value: "YIM"
parameter
required
string
seasonFieldId
required
string

Season field id

extension
required
string
Enum: ".kml" ".shp.zip" ".gml"
query Parameters
directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/telemetry/{date}/{mapType}/private/{parameter}/image{extension}

Authorizations:
oauth2
path Parameters
date
required
string
mapType
required
string
Value: "YIM"
parameter
required
string
seasonFieldId
required
string

Season field id

extension
required
string
Enum: ".png" ".tiff.zip" ".shp.zip" ".kmz"
query Parameters
directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/telemetry/{date}/{mapType}/private/{parameter}/legend.png

Authorizations:
oauth2
path Parameters
date
required
string
mapType
required
string
Value: "YIM"
parameter
required
string
seasonFieldId
required
string

Season field id

query Parameters
directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

Responses

season-fields/{seasonFieldId}/telemetry/{date}/{mapType}/private/{parameter}/notebook.png

Authorizations:
oauth2
path Parameters
date
required
string
mapType
required
string
Value: "YIM"
parameter
required
string
seasonFieldId
required
string

Season field id

query Parameters
directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/telemetry/{date}/{mapType}/private/{parameter}/scalebar.png

Authorizations:
oauth2
path Parameters
date
required
string
mapType
required
string
Value: "YIM"
parameter
required
string
seasonFieldId
required
string

Season field id

query Parameters
directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/telemetry/{date}/{mapType}/private/{parameter}/thumbnail.png

Authorizations:
oauth2
path Parameters
date
required
string
mapType
required
string
Value: "YIM"
parameter
required
string
seasonFieldId
required
string

Season field id

query Parameters
thumbnailSize
integer <int32>

Enable to define size of thumbnail image (square shape)

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/telemetry/{date}/{mapType}/private/{parameter}/world-file.pgw

Authorizations:
oauth2
path Parameters
date
required
string
mapType
required
string
Value: "YIM"
parameter
required
string
seasonFieldId
required
string

Season field id

query Parameters
directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

YieldVariabilityMap

maps/yield-variability-map/{mapType}

The Yield Variability Map API allows to create a Yield Variability Map based on a field boundary, a crop, a sowing date, the historical yield average, and the image date (using the Archive coverage API or Advance Coverage APIs).

This API is based on:

• Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• Map type

• Image date of the archive image (the Coverage APIs or the catalog imagery APIs.)

• Historical yield average

This API retrieves:

• URLs to display YPM map in PNG, GEOTIFF, Shapefile and KMZ formats, at 5 m resolution;

• URL to display the map thumbnail file as PNG format;

• URL to display the map legend in only available for PNG format;

• URL to display the world-file in PGW format to locate the map;

• URL to display the Notebook map as PNG format to locate the map on a background Google maps ;

• URL to display the scalebar in PNG format;

• URL to recover The HotSpot points in Shapefile, KMZ and GML formats by zone or by segment;

• The Histogram values by classes;

Authorizations:
oauth2
path Parameters
mapType
required
string
Value: "YPM"
query Parameters
thumbnailSize
integer <int32>

Enable to define size of thumbnail image (square shape)

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string
Request Body schema:
object (ImageReference)
historicalYieldAverage
number <float>
object (SeasonFieldReference)
name
string
tags
Array of strings
object

Responses

Request samples

Content type
{
  • "image": {
    },
  • "historicalYieldAverage": 0,
  • "seasonField": {
    },
  • "name": "string",
  • "tags": [
    ],
  • "externalIds": {
    }
}

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "tags": [
    ],
  • "externalIds": {
    },
  • "seasonField": {
    },
  • "_links": {
    },
  • "index": 0,
  • "hotSpots": [
    ],
  • "legend": {
    },
  • "zones": [
    ],
  • "histogram": {
    },
  • "date": "string",
  • "worldFile": {
    },
  • "mapSize": "string",
  • "bBox": {
    }
}

map-sets/yield-variability-map/{mapType}

This API allows to generate a set of several yield variability maps.

This API is based on:

• Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• Map type

• Historical yield average

This API retrieves:

• URLs to display YPM maps in PNG, GEOTIFF, Shapefile and KMZ formats, at 5 m resolution;

• URL to display the map thumbnail file as PNG format;

• URL to display the map legend in only available for PNG format;

• URL to display the world-file in PGW format to locate the map;

• URL to display the Notebook map as PNG format to locate the map on a background Google maps ;

• URL to display the scalebar in PNG format;

• URL to recover The HotSpot points in Shapefile, KMZ and GML formats by zone or by segment;

• The Histogram values by classes;

Authorizations:
oauth2
path Parameters
mapType
required
string
Value: "YPM"
query Parameters
directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string
Request Body schema:
imageMimeType
string
Array of objects (YieldVariabilityMapBodyParameters)

Responses

Request samples

Content type
{
  • "imageMimeType": "string",
  • "mapParams": [
    ]
}

Response samples

Content type
[
  • {
    }
]

season-fields/{seasonFieldId}/coverage/{imageReference}/yield-variability-map/{mapType}/historical-yield-average/{historicalYieldAverage}

This API allows to request Yield variability map by using shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The image date

• The map Type

• Historical yield average – Min 0, Max 999 (without unit)

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map type is :

• YPM

Authorizations:
oauth2
path Parameters
imageReference
required
string

Image reference using either the image date or the image id

historicalYieldAverage
required
number <float>
mapType
required
string
Value: "YPM"
seasonFieldId
required
string

Season field id

query Parameters
thumbnailSize
integer <int32>

Enable to define size of thumbnail image (square shape)

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "tags": [
    ],
  • "externalIds": {
    },
  • "seasonField": {
    },
  • "_links": {
    },
  • "index": 0,
  • "hotSpots": [
    ],
  • "legend": {
    },
  • "zones": [
    ],
  • "histogram": {
    },
  • "date": "string",
  • "worldFile": {
    },
  • "mapSize": "string",
  • "bBox": {
    }
}

season-fields/{seasonFieldId}/coverage/{imageReference}/yield-variability-map/{mapType}/historical-yield-average/{historicalYieldAverage}/hotspot{extension}

This API allows you to request the file containing hotspots of the Yield variabilty map by using shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The image date

• The map Type

• Historical yield average – Min 0, Max 999 (without unit)

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map type is :

• YPM

Authorizations:
oauth2
path Parameters
imageReference
required
string

Image reference using either the image date or the image id

historicalYieldAverage
required
number <float>
mapType
required
string
Value: "YPM"
seasonFieldId
required
string

Season field id

extension
required
string
Enum: ".kml" ".shp.zip" ".gml"
query Parameters
directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/coverage/{imageReference}/yield-variability-map/{mapType}/historical-yield-average/{historicalYieldAverage}/image{extension}

This API allows to request the Yield variability map image by using Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The image date

• The map Type

• Historical yield average – Min 0, Max 999 (without unit)

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map type is :

• YPM

The available extensions are:

• .shp.zip

• .tiff

• .kmz

• .png

Authorizations:
oauth2
path Parameters
imageReference
required
string

Image reference using either the image date or the image id

historicalYieldAverage
required
number <float>
mapType
required
string
Value: "YPM"
seasonFieldId
required
string

Season field id

extension
required
string
Enum: ".png" ".tiff.zip" ".shp.zip" ".kmz"
query Parameters
directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/coverage/{imageReference}/yield-variability-map/{mapType}/historical-yield-average/{historicalYieldAverage}/legend.png

This API allows to request the viriability goal map legend in PNG format by using by using Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The image date

• The map Type

• Historical yield average – Min 0, Max 999 (without unit)

• Minimum yield value – Mandatory value; Min 0, Max 999 (without unit)

• Maximum yield value – Mandatory value ; Min 0, Max 999 (without unit)

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map type is :

• YPM

Authorizations:
oauth2
path Parameters
imageReference
required
string

Image reference using either the image date or the image id

historicalYieldAverage
required
number <float>
mapType
required
string
Value: "YPM"
seasonFieldId
required
string

Season field id

query Parameters
directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

Responses

season-fields/{seasonFieldId}/coverage/{imageReference}/yield-variability-map/{mapType}/historical-yield-average/{historicalYieldAverage}/notebook.png

This API allows to request the viriability map Notebook in PNG format by using Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The image date

• The map Type

• Historical yield average – Min 0, Max 999 (without unit)

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map type is :

• YPM

Authorizations:
oauth2
path Parameters
imageReference
required
string

Image reference using either the image date or the image id

historicalYieldAverage
required
number <float>
mapType
required
string
Value: "YPM"
seasonFieldId
required
string

Season field id

query Parameters
directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/coverage/{imageReference}/yield-variability-map/{mapType}/historical-yield-average/{historicalYieldAverage}/scalebar.png

This API allows to request the yiel variability map scalebar in PNG format by using Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The image date

• The map Type

• Historical yield average – Min 0, Max 999 (without unit)

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map type is :

• YPM

Authorizations:
oauth2
path Parameters
imageReference
required
string

Image reference using either the image date or the image id

historicalYieldAverage
required
number <float>
mapType
required
string
Value: "YPM"
seasonFieldId
required
string

Season field id

query Parameters
directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/coverage/{imageReference}/yield-variability-map/{mapType}/historical-yield-average/{historicalYieldAverage}/thumbnail.png

This API allows to request the yield variability map thumbnail in PNG format by using Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The image date

• The map Type

• Historical yield average – Min 0, Max 999 (without unit)

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map type is :

• YPM

Authorizations:
oauth2
path Parameters
imageReference
required
string

Image reference using either the image date or the image id

historicalYieldAverage
required
number <float>
mapType
required
string
Value: "YPM"
seasonFieldId
required
string

Season field id

query Parameters
thumbnailSize
integer <int32>

Enable to define size of thumbnail image (square shape)

directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses

season-fields/{seasonFieldId}/coverage/{imageReference}/yield-variability-map/{mapType}/historical-yield-average/{historicalYieldAverage}/world-file.pgw

This API allows to request the world-file in PGW format to locate the Yield variability map with Shortcuts :

• The Season Field Identifiers (GEOSYS ID and/or Customer External ID)

• The image date

• The map Type

• Historical yield average – Min 0, Max 999 (without unit)

The image reference date can be recovered by using the Coverage APIs or the catalog imagery APIs.

The map type is :

• YPM

Authorizations:
oauth2
path Parameters
imageReference
required
string

Image reference using either the image date or the image id

historicalYieldAverage
required
number <float>
mapType
required
string
Value: "YPM"
seasonFieldId
required
string

Season field id

query Parameters
directLinks
boolean

Enable to disable direct URL to product in the response. When “True” is used only map links will be provided (map, legend, worldfile) When this parameter is not sent the “False” value is used.

legendType
string
Enum: "Fixed" "Dynamic" "OneByField" "Common"

The legend type to use. When this parameter is not sent, the “Dynamic” value is used.

zoning
boolean

Defined is the zoned map link has to be sent in the response. When this parameter is not sent the “False” value is used.

minZoneSize
number <double>

Zoning will make sure that the zones generated are bigger than the minZoneSize

wktPrecision
integer <int32>

Number of decimals in the generated geometries (only for EPSG 900913 or 3857)

useColorMapForZoning
boolean

Values: True or False. Value by default: False. if you provide a ColorMapId, it will be used instead of the default zoning map.

zoneCount
integer <int32>

This parameter sets the number of zone for the map to be created (minimum of 1, maximum of 255, no value will not be accepted)

colorMapId
string

If you provide a ColorMapId, it will be used instead of the default colorMap. There is no verification between ZoneCount & Number of classes in the ColorMap. If you do not have enough colours in your ColorMap, some area will be empty / no color on the png. If your ColorMap contains more colors than your ZoneCount, only the first N classes(N = Zonecount) will be used.

$epsg-out
integer <int32>

Output geometries projection code

stripingCorrection
boolean

Values: True or False. Value by default: False Correct the striping effect on the image.

zoningSegmentation
string
Enum: "None" "Polygon"

This parameter allows to recover point localization by segment Value: None or Polygon. Zoning and zonecount parameters need to be provided

hotSpot
boolean

This parameter allows to recover point localization by zone Values: True or False. Available on those map types: INSEASON_NDVI, INSEASON_EVI, INSEASON_GNDVI, INSEASON_CVI. Zoning and zonecount parameters need to be provided

hotSpotPosition
string
Enum: "None" "PointOnSurface" "Min" "Average" "Median" "Max" "PointOnSurfaceGEOS" "All"

This parameter allows to choose how to select hotspot

hotSpotFilter
string

This parameter allows to select X top and/or Y bottom hotspots based on the value for the metric. Filter by position

histogram
boolean

Display or not the values ​​of the histogram of the map in the response body. Values: True or False.

numberOfBins
integer <int32>

This parameter sets the number of classes for the histogram to be created (minimum of 1, maximum of 255)

noteBookSizeX
integer <int32>

Enable to define the width of the notebook

noteBookSizeY
integer <int32>

Enable to define the height of the notebook

clipping
string
Enum: "FieldBorder" "Bbox"

Indicates how the geometry is clipped, either using the field border, or its bounding box

header Parameters
headerParameters
string

Responses