A geometry is an AOI or a POI you use to create a tasking or a catalog order. If you use the same geometry in different orders, you can save geometries in the library and reuse them.
To add a new geometry to the library, call the Create a geometry endpoint with your workspace ID as the path parameter.
A valid request body consists of the following parameters:
displayName
: the name of the geometry, from 1 to 200 characters.featureCollection
: a GeoJSON feature collection. Only AOIs are supported.
A sample geometry
JSON
{
"displayName": "Berlin Tiergarten",
"featureCollection": {
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"type": "Polygon",
"coordinates": [
[
[77.259584, 28.622331],
[77.287879, 28.622632],
[77.287621, 28.594794],
[77.259389, 28.594983],
[77.259584, 28.622331]
]
]
}
}
]
}
}
You can retrieve saved geometries in one of the following ways:
- To get a list of all geometries, call the Get geometries endpoint.
- To get a specific geometry, call the Get a geometry endpoint with the geometry ID as the path parameter.
To change the name or the GeoJSON feature collection of a saved geometry, call the Update a geometry endpoint with the geometry ID as the path parameter.
You can change the values of the displayName
parameter, the featureCollection
object, or both.
My geometry isn’t valid. How do I fix it?
For information on how to create valid geometries, see Geometry guidelines.