The advanced query endpoint is accessible at /ogmapi/zone/query/ via a POST query.
The swagger documentation of the endpoint is available here: https://api.ogmapi.fr/schema/swagger/#/ogmapi/ogmapi_zone_query_create.
The "query" parameter is a JSON as described below.
TODO: query POST parameter
Define how to query a dataset. Filters labels of a dataset instance within a given area.
| Parameter | Type(s) | Description | Required |
|---|---|---|---|
| instance | str | Dataset instance ID | Required |
| area | Intersects | Area filters. Query the whole world if not provided. | Optional |
| labels | And, Or, Equals | Label filters. Get all elements within the area if not provided | Optional |
Get all elements with at least one part of their geometry within an area.
| Parameter | Type(s) | Description | Required |
|---|---|---|---|
| area | BoundingBox, SubQuery | The area. | Required |
A rectangle (in WGS-84).
| Parameter | Type(s) | Description | Required |
|---|---|---|---|
| north | float | Northen boundaries | Required |
| south | float | Southen boundaries | Required |
| east | float | Eastern boundaries | Required |
| west | float | Western boundaries | Required |
Get all elements within the geographical areas occupied by the objects returned by a sub-query.
| Parameter | Type(s) | Description | Required |
|---|---|---|---|
| query | Query | The sub query | Required |
Filters zones matching all of the related filters.
| Parameter | Type(s) | Description | Required |
|---|---|---|---|
| filters | List[Label filters] | List of label filters | Required, can be empty |
Filters zones matching at least one of the related filters.
| Parameter | Type(s) | Description | Required |
|---|---|---|---|
| filters | List[Label filters] | List of label filters | Required, can be empty |
Filters zones with a label equals (exactly) to a value.
| Parameter | Type(s) | Description | Required |
|---|---|---|---|
| label | str | Label JSON key | Required |
| value | str | Value | Required |
TODO