sdk.aoi_version.list()

List the AOIs that match the specified criteria.

List the available AOIs, including on the latest versions by default that match the specific filters. Additional options include the ability to list out all fields of the AOI Version by setting the verbose flag to True.

Parameters

geom_wkt (str) - geometry on which to intersect/filter AOI Version results
category (str) - filter for category field
tags (list) - filter for tags field
search_text (str) - keyword search for AOI metadata fields
creation_min (datetime) - minimum creation time of AOI Version
creation_max (datetime) - maximum creation time of AOI Version
aoi_fields (list) - AOI fields to include in response
verbose (bool) - flag to include all fields of the AOI Versions
[Optional] pagination (Pagination) - Pagination object only with page size field set

Returns

List[AOIVersion]

Example(s)

# List AOI Versions
await sdk.aoi_version.list(aoi_version_ids=[34979282],
                           geom_wkt="",
                           aoi_fields=["name","geom_wkt"])

# Output (List[AOIVersion])
[
  {
    "aoiId": "44bc2459-bc12-41d3-b362-3b471b05e8f7",
    "aoiName": "Mumbai",
    "attributes": {
        "geometry": {
            "coordinates": [
                [
                    [
                        [
                            72.85657337845379,
                            18.99872978199946
                        ],
                        [
                            72.80841144722376,
                            18.894879649964
                        ],
                        [
                            72.8285999637767,
                            18.897356617909498
                        ],
                        [
                            72.87014058311075,
                            18.94989740262145
                        ],
                        [
                            72.91474540822836,
                            18.99444735532734
                        ],
                        [
                            72.92060609991555,
                            19.02137645771109
                        ],
                        [
                            72.87907915917089,
                            19.01548701875258
                        ],
                        [
                            72.85657337845379,
                            18.99872978199946
                        ]
                    ]
                ]
            ],
            "type": "MultiPolygon"
        }
    },
    "category": "OTHER",
    "geomWkt": "MULTIPOLYGON (((72.85657337845379 18.99872978199946, 72.80841144722376 18.894879649964, 72.8285999637767 18.8973566179095, 72.87014058311075 18.94989740262145, 72.91474540822836 18.99444735532734, 72.92060609991555 19.02137645771109, 72.87907915917089 19.01548701875258, 72.85657337845379 18.99872978199946)))",
    "id": 41612400,
    "localTimezone": "Asia/Kolkata",
    "source": "USER_CREATED",
    "type": "USER_CREATED"
  }
]