ARLAS Server APIs vAPI_VERSION
Scroll down for example requests and responses.
Explore the content of ARLAS collections
Base URLs:
Email: Gisaia Web: Gisaia License: Apache 2.0
collections
Collections API
Get a collection reference
GET /collections/{collection}
Get a collection reference in ARLAS
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| collection | path | string | true | collection |
| pretty | query | boolean | false | Pretty print |
Example responses
200 Response
{
"collection_name": "string",
"params": {
"index_name": "string",
"id_path": "string",
"geometry_path": "string",
"centroid_path": "string",
"timestamp_path": "string",
"exclude_fields": "string",
"update_max_hits": 0,
"taggable_fields": "string",
"exclude_wfs_fields": "string",
"custom_params": {
"property1": "string",
"property2": "string"
},
"display_names": {
"collection": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"shape_columns": {
"property1": "string",
"property2": "string"
}
},
"organisations": {
"owner": "string",
"shared": [
"string"
],
"public": true
},
"atom_feed": {
"author": {
"name": "string",
"email": "string",
"uri": "string"
},
"contributor": {
"name": "string",
"email": "string",
"uri": "string"
},
"icon": "string",
"logo": "string",
"rights": "string",
"subtitle": "string",
"generator": {
"name": "string",
"version": "string",
"uri": "string"
}
},
"open_search": {
"short_name": "string",
"description": "string",
"contact": "string",
"tags": "string",
"long_name": "string",
"image_height": "string",
"image_width": "string",
"image_type": "string",
"image_url": "string",
"developer": "string",
"attribution": "string",
"syndication_right": "string",
"adult_content": "string",
"language": "string",
"input_encoding": "string",
"output_encoding": "string"
},
"inspire": {
"keywords": [
{
"value": "string",
"vocabulary": "string",
"date_of_publication": "string"
}
],
"topic_categories": [
"string"
],
"lineage": "string",
"languages": [
"string"
],
"spatial_resolution": {
"value": 0,
"unit_of_measure": "string"
},
"inspire_uri": {
"code": "string",
"namespace": "string"
},
"inspire_limitation_access": {
"access_constraints": "string",
"other_constraints": "string",
"classification": "string"
},
"inspire_use_conditions": "string"
},
"dublin_core_element_name": {
"title": "string",
"creator": "string",
"subject": "string",
"description": "string",
"publisher": "string",
"contributor": "string",
"type": "string",
"format": "string",
"identifier": "string",
"source": "string",
"language": "string",
"bbox": {
"north": 0.1,
"south": 0.1,
"east": 0.1,
"west": 0.1
},
"date": "string",
"coverage": {},
"coverage_centroid": "string"
},
"raster_tile_url": {
"url": "string",
"id_path": "string",
"min_z": 0,
"max_z": 0,
"check_geometry": true
},
"raster_tile_width": 0,
"raster_tile_height": 0,
"filter": {
"f": [
[
{
"field": "string",
"op": "eq",
"value": "string"
}
]
],
"q": [
[
"string"
]
],
"dateformat": "string",
"righthand": true
},
"license_name": "string",
"license_urls": [
"string"
]
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful operation | CollectionReference |
| 404 | Not Found | Collection not found. | Error |
| 500 | Internal Server Error | Arlas Server Error. | Error |
Add a collection reference
PUT /collections/{collection}
Add a collection reference in ARLAS
Body parameter
{
"index_name": "string",
"id_path": "string",
"geometry_path": "string",
"centroid_path": "string",
"timestamp_path": "string",
"exclude_fields": "string",
"update_max_hits": 0,
"taggable_fields": "string",
"exclude_wfs_fields": "string",
"custom_params": {
"property1": "string",
"property2": "string"
},
"display_names": {
"collection": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"shape_columns": {
"property1": "string",
"property2": "string"
}
},
"organisations": {
"owner": "string",
"shared": [
"string"
],
"public": true
},
"atom_feed": {
"author": {
"name": "string",
"email": "string",
"uri": "string"
},
"contributor": {
"name": "string",
"email": "string",
"uri": "string"
},
"icon": "string",
"logo": "string",
"rights": "string",
"subtitle": "string",
"generator": {
"name": "string",
"version": "string",
"uri": "string"
}
},
"open_search": {
"short_name": "string",
"description": "string",
"contact": "string",
"tags": "string",
"long_name": "string",
"image_height": "string",
"image_width": "string",
"image_type": "string",
"image_url": "string",
"developer": "string",
"attribution": "string",
"syndication_right": "string",
"adult_content": "string",
"language": "string",
"input_encoding": "string",
"output_encoding": "string"
},
"inspire": {
"keywords": [
{
"value": "string",
"vocabulary": "string",
"date_of_publication": "string"
}
],
"topic_categories": [
"string"
],
"lineage": "string",
"languages": [
"string"
],
"spatial_resolution": {
"value": 0,
"unit_of_measure": "string"
},
"inspire_uri": {
"code": "string",
"namespace": "string"
},
"inspire_limitation_access": {
"access_constraints": "string",
"other_constraints": "string",
"classification": "string"
},
"inspire_use_conditions": "string"
},
"dublin_core_element_name": {
"title": "string",
"creator": "string",
"subject": "string",
"description": "string",
"publisher": "string",
"contributor": "string",
"type": "string",
"format": "string",
"identifier": "string",
"source": "string",
"language": "string",
"bbox": {
"north": 0.1,
"south": 0.1,
"east": 0.1,
"west": 0.1
},
"date": "string",
"coverage": {},
"coverage_centroid": "string"
},
"raster_tile_url": {
"url": "string",
"id_path": "string",
"min_z": 0,
"max_z": 0,
"check_geometry": true
},
"raster_tile_width": 0,
"raster_tile_height": 0,
"filter": {
"f": [
[
{
"field": "string",
"op": "eq",
"value": "string"
}
]
],
"q": [
[
"string"
]
],
"dateformat": "string",
"righthand": true
},
"license_name": "string",
"license_urls": [
"string"
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| collection | path | string | true | collection |
| pretty | query | boolean | false | Pretty print |
| checkfields | query | boolean | false | none |
| body | body | CollectionReferenceParameters | true | collectionParams |
Example responses
200 Response
{
"collection_name": "string",
"params": {
"index_name": "string",
"id_path": "string",
"geometry_path": "string",
"centroid_path": "string",
"timestamp_path": "string",
"exclude_fields": "string",
"update_max_hits": 0,
"taggable_fields": "string",
"exclude_wfs_fields": "string",
"custom_params": {
"property1": "string",
"property2": "string"
},
"display_names": {
"collection": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"shape_columns": {
"property1": "string",
"property2": "string"
}
},
"organisations": {
"owner": "string",
"shared": [
"string"
],
"public": true
},
"atom_feed": {
"author": {
"name": "string",
"email": "string",
"uri": "string"
},
"contributor": {
"name": "string",
"email": "string",
"uri": "string"
},
"icon": "string",
"logo": "string",
"rights": "string",
"subtitle": "string",
"generator": {
"name": "string",
"version": "string",
"uri": "string"
}
},
"open_search": {
"short_name": "string",
"description": "string",
"contact": "string",
"tags": "string",
"long_name": "string",
"image_height": "string",
"image_width": "string",
"image_type": "string",
"image_url": "string",
"developer": "string",
"attribution": "string",
"syndication_right": "string",
"adult_content": "string",
"language": "string",
"input_encoding": "string",
"output_encoding": "string"
},
"inspire": {
"keywords": [
{
"value": "string",
"vocabulary": "string",
"date_of_publication": "string"
}
],
"topic_categories": [
"string"
],
"lineage": "string",
"languages": [
"string"
],
"spatial_resolution": {
"value": 0,
"unit_of_measure": "string"
},
"inspire_uri": {
"code": "string",
"namespace": "string"
},
"inspire_limitation_access": {
"access_constraints": "string",
"other_constraints": "string",
"classification": "string"
},
"inspire_use_conditions": "string"
},
"dublin_core_element_name": {
"title": "string",
"creator": "string",
"subject": "string",
"description": "string",
"publisher": "string",
"contributor": "string",
"type": "string",
"format": "string",
"identifier": "string",
"source": "string",
"language": "string",
"bbox": {
"north": 0.1,
"south": 0.1,
"east": 0.1,
"west": 0.1
},
"date": "string",
"coverage": {},
"coverage_centroid": "string"
},
"raster_tile_url": {
"url": "string",
"id_path": "string",
"min_z": 0,
"max_z": 0,
"check_geometry": true
},
"raster_tile_width": 0,
"raster_tile_height": 0,
"filter": {
"f": [
[
{
"field": "string",
"op": "eq",
"value": "string"
}
]
],
"q": [
[
"string"
]
],
"dateformat": "string",
"righthand": true
},
"license_name": "string",
"license_urls": [
"string"
]
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful operation | CollectionReference |
| 400 | Bad Request | JSON parameter malformed. | Error |
| 404 | Not Found | Not Found Error. | Error |
| 500 | Internal Server Error | Arlas Server Error. | Error |
Delete a collection reference
DELETE /collections/{collection}
Delete a collection reference in ARLAS
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| collection | path | string | true | collection |
| pretty | query | boolean | false | Pretty print |
Example responses
200 Response
{
"status": 0,
"message": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful operation | Success |
| 404 | Not Found | Collection not found. | Error |
| 500 | Internal Server Error | Arlas Server Error. | Error |
Get all collection references as a json file
GET /collections/_export
Get all collection references in ARLAS as json file
Example responses
200 Response
[
{
"collection_name": "string",
"params": {
"index_name": "string",
"id_path": "string",
"geometry_path": "string",
"centroid_path": "string",
"timestamp_path": "string",
"exclude_fields": "string",
"update_max_hits": 0,
"taggable_fields": "string",
"exclude_wfs_fields": "string",
"custom_params": {
"property1": "string",
"property2": "string"
},
"display_names": {
"collection": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"shape_columns": {
"property1": "string",
"property2": "string"
}
},
"organisations": {
"owner": "string",
"shared": [
"string"
],
"public": true
},
"atom_feed": {
"author": {
"name": "string",
"email": "string",
"uri": "string"
},
"contributor": {
"name": "string",
"email": "string",
"uri": "string"
},
"icon": "string",
"logo": "string",
"rights": "string",
"subtitle": "string",
"generator": {
"name": "string",
"version": "string",
"uri": "string"
}
},
"open_search": {
"short_name": "string",
"description": "string",
"contact": "string",
"tags": "string",
"long_name": "string",
"image_height": "string",
"image_width": "string",
"image_type": "string",
"image_url": "string",
"developer": "string",
"attribution": "string",
"syndication_right": "string",
"adult_content": "string",
"language": "string",
"input_encoding": "string",
"output_encoding": "string"
},
"inspire": {
"keywords": [
{
"value": "string",
"vocabulary": "string",
"date_of_publication": "string"
}
],
"topic_categories": [
"string"
],
"lineage": "string",
"languages": [
"string"
],
"spatial_resolution": {
"value": 0,
"unit_of_measure": "string"
},
"inspire_uri": {
"code": "string",
"namespace": "string"
},
"inspire_limitation_access": {
"access_constraints": "string",
"other_constraints": "string",
"classification": "string"
},
"inspire_use_conditions": "string"
},
"dublin_core_element_name": {
"title": "string",
"creator": "string",
"subject": "string",
"description": "string",
"publisher": "string",
"contributor": "string",
"type": "string",
"format": "string",
"identifier": "string",
"source": "string",
"language": "string",
"bbox": {
"north": 0.1,
"south": 0.1,
"east": 0.1,
"west": 0.1
},
"date": "string",
"coverage": {},
"coverage_centroid": "string"
},
"raster_tile_url": {
"url": "string",
"id_path": "string",
"min_z": 0,
"max_z": 0,
"check_geometry": true
},
"raster_tile_width": 0,
"raster_tile_height": 0,
"filter": {
"f": [
[
{
"field": "string",
"op": "eq",
"value": "string"
}
]
],
"q": [
[
"string"
]
],
"dateformat": "string",
"righthand": true
},
"license_name": "string",
"license_urls": [
"string"
]
}
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful operation | Inline |
| 500 | Internal Server Error | Arlas Server Error. | Error |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [CollectionReference] | false | none | none |
| » collection_name | string | true | none | none |
| » params | CollectionReferenceParameters | true | none | none |
| »» index_name | string | true | none | none |
| »» id_path | string | true | none | none |
| »» geometry_path | string | true | none | none |
| »» centroid_path | string | true | none | none |
| »» timestamp_path | string | true | none | none |
| »» exclude_fields | string | false | none | none |
| »» update_max_hits | integer(int32) | false | none | none |
| »» taggable_fields | string | false | none | none |
| »» exclude_wfs_fields | string | false | none | none |
| »» custom_params | object | false | none | none |
| »»» additionalProperties | string | false | none | none |
| »» display_names | CollectionDisplayNames | false | none | none |
| »»» collection | string | false | none | none |
| »»» fields | object | false | none | none |
| »»»» additionalProperties | string | false | none | none |
| »»» shape_columns | object | false | none | none |
| »»»» additionalProperties | string | false | none | none |
| »» organisations | CollectionOrganisations | false | none | none |
| »»» owner | string | false | none | none |
| »»» shared | [string] | false | none | none |
| »»» public | boolean | false | none | none |
| »» atom_feed | Feed | false | none | none |
| »»» author | Person | false | none | none |
| »»»» name | string | false | none | none |
| string | false | none | none | |
| »»»» uri | string | false | none | none |
| »»» contributor | Person | false | none | none |
| »»» icon | string | false | none | none |
| »»» logo | string | false | none | none |
| »»» rights | string | false | none | none |
| »»» subtitle | string | false | none | none |
| »»» generator | Generator | false | none | none |
| »»»» name | string | false | none | none |
| »»»» version | string | false | none | none |
| »»»» uri | string | false | none | none |
| »» open_search | OpenSearch | false | none | none |
| »»» short_name | string | false | none | none |
| »»» description | string | false | none | none |
| »»» contact | string | false | none | none |
| »»» tags | string | false | none | none |
| »»» long_name | string | false | none | none |
| »»» image_height | string | false | none | none |
| »»» image_width | string | false | none | none |
| »»» image_type | string | false | none | none |
| »»» image_url | string | false | none | none |
| »»» developer | string | false | none | none |
| »»» attribution | string | false | none | none |
| »»» syndication_right | string | false | none | none |
| »»» adult_content | string | false | none | none |
| »»» language | string | false | none | none |
| »»» input_encoding | string | false | none | none |
| »»» output_encoding | string | false | none | none |
| »» inspire | Inspire | false | none | none |
| »»» keywords | [Keyword] | false | none | none |
| »»»» value | string | false | none | none |
| »»»» vocabulary | string | false | none | none |
| »»»» date_of_publication | string | false | none | none |
| »»» topic_categories | [string] | false | none | none |
| »»» lineage | string | false | none | none |
| »»» languages | [string] | false | none | none |
| »»» spatial_resolution | InspireSpatialResolution | false | none | none |
| »»»» value | number | false | none | none |
| »»»» unit_of_measure | string | false | none | none |
| »»» inspire_uri | InspireURI | false | none | none |
| »»»» code | string | false | none | none |
| »»»» namespace | string | false | none | none |
| »»» inspire_limitation_access | InspireLimitationAccess | false | none | none |
| »»»» access_constraints | string | false | none | none |
| »»»» other_constraints | string | false | none | none |
| »»»» classification | string | false | none | none |
| »»» inspire_use_conditions | string | false | none | none |
| »» dublin_core_element_name | DublinCoreElementName | false | none | none |
| »»» title | string | false | none | none |
| »»» creator | string | false | none | none |
| »»» subject | string | false | none | none |
| »»» description | string | false | none | none |
| »»» publisher | string | false | none | none |
| »»» contributor | string | false | none | none |
| »»» type | string | false | none | none |
| »»» format | string | false | none | none |
| »»» identifier | string | false | none | none |
| »»» source | string | false | none | none |
| »»» language | string | false | none | none |
| »»» bbox | Bbox | false | none | none |
| »»»» north | number(double) | true | none | none |
| »»»» south | number(double) | true | none | none |
| »»»» east | number(double) | true | none | none |
| »»»» west | number(double) | true | none | none |
| »»» date | string | false | none | none |
| »»» coverage | object | false | none | none |
| »»» coverage_centroid | string | false | none | none |
| »» raster_tile_url | RasterTileURL | false | none | none |
| »»» url | string | true | none | none |
| »»» id_path | string | true | none | none |
| »»» min_z | integer(int32) | false | none | none |
| »»» max_z | integer(int32) | false | none | none |
| »»» check_geometry | boolean | false | none | none |
| »» raster_tile_width | integer(int32) | false | none | none |
| »» raster_tile_height | integer(int32) | false | none | none |
| »» filter | Filter | false | none | none |
| »»» f | [array] | false | none | none |
| »»»» field | string | false | none | none |
| »»»» op | string | false | none | none |
| »»»» value | string | false | none | none |
| »»»» empty | boolean | false | none | none |
| » q | [array] | false | none | none |
| »» empty | boolean | false | none | none |
| » dateformat | string | false | none | none |
| » righthand | boolean | false | none | none |
| license_name | string | false | none | none |
| license_urls | [string] | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| op | eq |
| op | gte |
| op | gt |
| op | lte |
| op | lt |
| op | like |
| op | ne |
| op | range |
| op | within |
| op | notwithin |
| op | intersects |
| op | notintersects |
Get all collection references
GET /collections
Get all collection references in ARLAS
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| pretty | query | boolean | false | Pretty print |
Example responses
200 Response
[
{
"collection_name": "string",
"params": {
"index_name": "string",
"id_path": "string",
"geometry_path": "string",
"centroid_path": "string",
"timestamp_path": "string",
"exclude_fields": "string",
"update_max_hits": 0,
"taggable_fields": "string",
"exclude_wfs_fields": "string",
"custom_params": {
"property1": "string",
"property2": "string"
},
"display_names": {
"collection": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"shape_columns": {
"property1": "string",
"property2": "string"
}
},
"organisations": {
"owner": "string",
"shared": [
"string"
],
"public": true
},
"atom_feed": {
"author": {
"name": "string",
"email": "string",
"uri": "string"
},
"contributor": {
"name": "string",
"email": "string",
"uri": "string"
},
"icon": "string",
"logo": "string",
"rights": "string",
"subtitle": "string",
"generator": {
"name": "string",
"version": "string",
"uri": "string"
}
},
"open_search": {
"short_name": "string",
"description": "string",
"contact": "string",
"tags": "string",
"long_name": "string",
"image_height": "string",
"image_width": "string",
"image_type": "string",
"image_url": "string",
"developer": "string",
"attribution": "string",
"syndication_right": "string",
"adult_content": "string",
"language": "string",
"input_encoding": "string",
"output_encoding": "string"
},
"inspire": {
"keywords": [
{
"value": "string",
"vocabulary": "string",
"date_of_publication": "string"
}
],
"topic_categories": [
"string"
],
"lineage": "string",
"languages": [
"string"
],
"spatial_resolution": {
"value": 0,
"unit_of_measure": "string"
},
"inspire_uri": {
"code": "string",
"namespace": "string"
},
"inspire_limitation_access": {
"access_constraints": "string",
"other_constraints": "string",
"classification": "string"
},
"inspire_use_conditions": "string"
},
"dublin_core_element_name": {
"title": "string",
"creator": "string",
"subject": "string",
"description": "string",
"publisher": "string",
"contributor": "string",
"type": "string",
"format": "string",
"identifier": "string",
"source": "string",
"language": "string",
"bbox": {
"north": 0.1,
"south": 0.1,
"east": 0.1,
"west": 0.1
},
"date": "string",
"coverage": {},
"coverage_centroid": "string"
},
"raster_tile_url": {
"url": "string",
"id_path": "string",
"min_z": 0,
"max_z": 0,
"check_geometry": true
},
"raster_tile_width": 0,
"raster_tile_height": 0,
"filter": {
"f": [
[
{
"field": "string",
"op": "eq",
"value": "string"
}
]
],
"q": [
[
"string"
]
],
"dateformat": "string",
"righthand": true
},
"license_name": "string",
"license_urls": [
"string"
]
}
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful operation | Inline |
| 500 | Internal Server Error | Arlas Server Error. | Error |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [CollectionReference] | false | none | none |
| » collection_name | string | true | none | none |
| » params | CollectionReferenceParameters | true | none | none |
| »» index_name | string | true | none | none |
| »» id_path | string | true | none | none |
| »» geometry_path | string | true | none | none |
| »» centroid_path | string | true | none | none |
| »» timestamp_path | string | true | none | none |
| »» exclude_fields | string | false | none | none |
| »» update_max_hits | integer(int32) | false | none | none |
| »» taggable_fields | string | false | none | none |
| »» exclude_wfs_fields | string | false | none | none |
| »» custom_params | object | false | none | none |
| »»» additionalProperties | string | false | none | none |
| »» display_names | CollectionDisplayNames | false | none | none |
| »»» collection | string | false | none | none |
| »»» fields | object | false | none | none |
| »»»» additionalProperties | string | false | none | none |
| »»» shape_columns | object | false | none | none |
| »»»» additionalProperties | string | false | none | none |
| »» organisations | CollectionOrganisations | false | none | none |
| »»» owner | string | false | none | none |
| »»» shared | [string] | false | none | none |
| »»» public | boolean | false | none | none |
| »» atom_feed | Feed | false | none | none |
| »»» author | Person | false | none | none |
| »»»» name | string | false | none | none |
| string | false | none | none | |
| »»»» uri | string | false | none | none |
| »»» contributor | Person | false | none | none |
| »»» icon | string | false | none | none |
| »»» logo | string | false | none | none |
| »»» rights | string | false | none | none |
| »»» subtitle | string | false | none | none |
| »»» generator | Generator | false | none | none |
| »»»» name | string | false | none | none |
| »»»» version | string | false | none | none |
| »»»» uri | string | false | none | none |
| »» open_search | OpenSearch | false | none | none |
| »»» short_name | string | false | none | none |
| »»» description | string | false | none | none |
| »»» contact | string | false | none | none |
| »»» tags | string | false | none | none |
| »»» long_name | string | false | none | none |
| »»» image_height | string | false | none | none |
| »»» image_width | string | false | none | none |
| »»» image_type | string | false | none | none |
| »»» image_url | string | false | none | none |
| »»» developer | string | false | none | none |
| »»» attribution | string | false | none | none |
| »»» syndication_right | string | false | none | none |
| »»» adult_content | string | false | none | none |
| »»» language | string | false | none | none |
| »»» input_encoding | string | false | none | none |
| »»» output_encoding | string | false | none | none |
| »» inspire | Inspire | false | none | none |
| »»» keywords | [Keyword] | false | none | none |
| »»»» value | string | false | none | none |
| »»»» vocabulary | string | false | none | none |
| »»»» date_of_publication | string | false | none | none |
| »»» topic_categories | [string] | false | none | none |
| »»» lineage | string | false | none | none |
| »»» languages | [string] | false | none | none |
| »»» spatial_resolution | InspireSpatialResolution | false | none | none |
| »»»» value | number | false | none | none |
| »»»» unit_of_measure | string | false | none | none |
| »»» inspire_uri | InspireURI | false | none | none |
| »»»» code | string | false | none | none |
| »»»» namespace | string | false | none | none |
| »»» inspire_limitation_access | InspireLimitationAccess | false | none | none |
| »»»» access_constraints | string | false | none | none |
| »»»» other_constraints | string | false | none | none |
| »»»» classification | string | false | none | none |
| »»» inspire_use_conditions | string | false | none | none |
| »» dublin_core_element_name | DublinCoreElementName | false | none | none |
| »»» title | string | false | none | none |
| »»» creator | string | false | none | none |
| »»» subject | string | false | none | none |
| »»» description | string | false | none | none |
| »»» publisher | string | false | none | none |
| »»» contributor | string | false | none | none |
| »»» type | string | false | none | none |
| »»» format | string | false | none | none |
| »»» identifier | string | false | none | none |
| »»» source | string | false | none | none |
| »»» language | string | false | none | none |
| »»» bbox | Bbox | false | none | none |
| »»»» north | number(double) | true | none | none |
| »»»» south | number(double) | true | none | none |
| »»»» east | number(double) | true | none | none |
| »»»» west | number(double) | true | none | none |
| »»» date | string | false | none | none |
| »»» coverage | object | false | none | none |
| »»» coverage_centroid | string | false | none | none |
| »» raster_tile_url | RasterTileURL | false | none | none |
| »»» url | string | true | none | none |
| »»» id_path | string | true | none | none |
| »»» min_z | integer(int32) | false | none | none |
| »»» max_z | integer(int32) | false | none | none |
| »»» check_geometry | boolean | false | none | none |
| »» raster_tile_width | integer(int32) | false | none | none |
| »» raster_tile_height | integer(int32) | false | none | none |
| »» filter | Filter | false | none | none |
| »»» f | [array] | false | none | none |
| »»»» field | string | false | none | none |
| »»»» op | string | false | none | none |
| »»»» value | string | false | none | none |
| »»»» empty | boolean | false | none | none |
| » q | [array] | false | none | none |
| »» empty | boolean | false | none | none |
| » dateformat | string | false | none | none |
| » righthand | boolean | false | none | none |
| license_name | string | false | none | none |
| license_urls | [string] | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| op | eq |
| op | gte |
| op | gt |
| op | lte |
| op | lt |
| op | like |
| op | ne |
| op | range |
| op | within |
| op | notwithin |
| op | intersects |
| op | notintersects |
Add collection references from a json file
POST /collections/_import
Add collection references in ARLAS from a json file
Body parameter
file:
type: string
parameters:
property1: string
property2: string
fileName: string
creationDate: 2019-08-24T14:15:22Z
modificationDate: 2019-08-24T14:15:22Z
readDate: 2019-08-24T14:15:22Z
size: 0
name: string
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | object | false | none |
| » file | body | FormDataContentDisposition | false | none |
| »» type | body | string | false | none |
| »» parameters | body | object | false | none |
| »»» additionalProperties | body | string | false | none |
| »» fileName | body | string | false | none |
| »» creationDate | body | string(date-time) | false | none |
| »» modificationDate | body | string(date-time) | false | none |
| »» readDate | body | string(date-time) | false | none |
| »» size | body | integer(int64) | false | none |
| »» name | body | string | false | none |
Example responses
200 Response
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful operation | string |
| 500 | Internal Server Error | Arlas Server Error. | Error |
Update a collection reference's organisations attribute.
PATCH /collections/{collection}/organisations
Update a collection reference's organisations attribute.
Body parameter
{
"public": true,
"shared": [
"string"
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| collection | path | string | true | collection |
| pretty | query | boolean | false | Pretty print |
| body | body | CollectionReferenceUpdateOrg | true | organisationsParamsUpdate |
Example responses
200 Response
{
"collection_name": "string",
"params": {
"index_name": "string",
"id_path": "string",
"geometry_path": "string",
"centroid_path": "string",
"timestamp_path": "string",
"exclude_fields": "string",
"update_max_hits": 0,
"taggable_fields": "string",
"exclude_wfs_fields": "string",
"custom_params": {
"property1": "string",
"property2": "string"
},
"display_names": {
"collection": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"shape_columns": {
"property1": "string",
"property2": "string"
}
},
"organisations": {
"owner": "string",
"shared": [
"string"
],
"public": true
},
"atom_feed": {
"author": {
"name": "string",
"email": "string",
"uri": "string"
},
"contributor": {
"name": "string",
"email": "string",
"uri": "string"
},
"icon": "string",
"logo": "string",
"rights": "string",
"subtitle": "string",
"generator": {
"name": "string",
"version": "string",
"uri": "string"
}
},
"open_search": {
"short_name": "string",
"description": "string",
"contact": "string",
"tags": "string",
"long_name": "string",
"image_height": "string",
"image_width": "string",
"image_type": "string",
"image_url": "string",
"developer": "string",
"attribution": "string",
"syndication_right": "string",
"adult_content": "string",
"language": "string",
"input_encoding": "string",
"output_encoding": "string"
},
"inspire": {
"keywords": [
{
"value": "string",
"vocabulary": "string",
"date_of_publication": "string"
}
],
"topic_categories": [
"string"
],
"lineage": "string",
"languages": [
"string"
],
"spatial_resolution": {
"value": 0,
"unit_of_measure": "string"
},
"inspire_uri": {
"code": "string",
"namespace": "string"
},
"inspire_limitation_access": {
"access_constraints": "string",
"other_constraints": "string",
"classification": "string"
},
"inspire_use_conditions": "string"
},
"dublin_core_element_name": {
"title": "string",
"creator": "string",
"subject": "string",
"description": "string",
"publisher": "string",
"contributor": "string",
"type": "string",
"format": "string",
"identifier": "string",
"source": "string",
"language": "string",
"bbox": {
"north": 0.1,
"south": 0.1,
"east": 0.1,
"west": 0.1
},
"date": "string",
"coverage": {},
"coverage_centroid": "string"
},
"raster_tile_url": {
"url": "string",
"id_path": "string",
"min_z": 0,
"max_z": 0,
"check_geometry": true
},
"raster_tile_width": 0,
"raster_tile_height": 0,
"filter": {
"f": [
[
{
"field": "string",
"op": "eq",
"value": "string"
}
]
],
"q": [
[
"string"
]
],
"dateformat": "string",
"righthand": true
},
"license_name": "string",
"license_urls": [
"string"
]
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful operation | CollectionReference |
| 400 | Bad Request | JSON parameter malformed. | Error |
| 404 | Not Found | Collection not found. | Error |
| 500 | Internal Server Error | Arlas Server Error. | Error |
Update a collection reference's display collection name attribute.
PATCH /collections/{collection}/display_names/collection
Update a collection reference's display collection name attribute.
Body parameter
"string"
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| collection | path | string | true | collection |
| pretty | query | boolean | false | Pretty print |
| body | body | string | true | collectionDisplayName |
Example responses
200 Response
{
"collection_name": "string",
"params": {
"index_name": "string",
"id_path": "string",
"geometry_path": "string",
"centroid_path": "string",
"timestamp_path": "string",
"exclude_fields": "string",
"update_max_hits": 0,
"taggable_fields": "string",
"exclude_wfs_fields": "string",
"custom_params": {
"property1": "string",
"property2": "string"
},
"display_names": {
"collection": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"shape_columns": {
"property1": "string",
"property2": "string"
}
},
"organisations": {
"owner": "string",
"shared": [
"string"
],
"public": true
},
"atom_feed": {
"author": {
"name": "string",
"email": "string",
"uri": "string"
},
"contributor": {
"name": "string",
"email": "string",
"uri": "string"
},
"icon": "string",
"logo": "string",
"rights": "string",
"subtitle": "string",
"generator": {
"name": "string",
"version": "string",
"uri": "string"
}
},
"open_search": {
"short_name": "string",
"description": "string",
"contact": "string",
"tags": "string",
"long_name": "string",
"image_height": "string",
"image_width": "string",
"image_type": "string",
"image_url": "string",
"developer": "string",
"attribution": "string",
"syndication_right": "string",
"adult_content": "string",
"language": "string",
"input_encoding": "string",
"output_encoding": "string"
},
"inspire": {
"keywords": [
{
"value": "string",
"vocabulary": "string",
"date_of_publication": "string"
}
],
"topic_categories": [
"string"
],
"lineage": "string",
"languages": [
"string"
],
"spatial_resolution": {
"value": 0,
"unit_of_measure": "string"
},
"inspire_uri": {
"code": "string",
"namespace": "string"
},
"inspire_limitation_access": {
"access_constraints": "string",
"other_constraints": "string",
"classification": "string"
},
"inspire_use_conditions": "string"
},
"dublin_core_element_name": {
"title": "string",
"creator": "string",
"subject": "string",
"description": "string",
"publisher": "string",
"contributor": "string",
"type": "string",
"format": "string",
"identifier": "string",
"source": "string",
"language": "string",
"bbox": {
"north": 0.1,
"south": 0.1,
"east": 0.1,
"west": 0.1
},
"date": "string",
"coverage": {},
"coverage_centroid": "string"
},
"raster_tile_url": {
"url": "string",
"id_path": "string",
"min_z": 0,
"max_z": 0,
"check_geometry": true
},
"raster_tile_width": 0,
"raster_tile_height": 0,
"filter": {
"f": [
[
{
"field": "string",
"op": "eq",
"value": "string"
}
]
],
"q": [
[
"string"
]
],
"dateformat": "string",
"righthand": true
},
"license_name": "string",
"license_urls": [
"string"
]
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful operation | CollectionReference |
| 400 | Bad Request | JSON parameter malformed. | Error |
| 404 | Not Found | Collection not found. | Error |
| 500 | Internal Server Error | Arlas Server Error. | Error |
Update a collection reference's display fields name attribute.
PATCH /collections/{collection}/display_names/fields
Update a collection reference's display fields name attribute.
Body parameter
{
"property1": "string",
"property2": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| collection | path | string | true | collection |
| pretty | query | boolean | false | Pretty print |
| body | body | object | true | fieldsDisplayNames |
| » additionalProperties | body | string | false | none |
Example responses
200 Response
{
"collection_name": "string",
"params": {
"index_name": "string",
"id_path": "string",
"geometry_path": "string",
"centroid_path": "string",
"timestamp_path": "string",
"exclude_fields": "string",
"update_max_hits": 0,
"taggable_fields": "string",
"exclude_wfs_fields": "string",
"custom_params": {
"property1": "string",
"property2": "string"
},
"display_names": {
"collection": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"shape_columns": {
"property1": "string",
"property2": "string"
}
},
"organisations": {
"owner": "string",
"shared": [
"string"
],
"public": true
},
"atom_feed": {
"author": {
"name": "string",
"email": "string",
"uri": "string"
},
"contributor": {
"name": "string",
"email": "string",
"uri": "string"
},
"icon": "string",
"logo": "string",
"rights": "string",
"subtitle": "string",
"generator": {
"name": "string",
"version": "string",
"uri": "string"
}
},
"open_search": {
"short_name": "string",
"description": "string",
"contact": "string",
"tags": "string",
"long_name": "string",
"image_height": "string",
"image_width": "string",
"image_type": "string",
"image_url": "string",
"developer": "string",
"attribution": "string",
"syndication_right": "string",
"adult_content": "string",
"language": "string",
"input_encoding": "string",
"output_encoding": "string"
},
"inspire": {
"keywords": [
{
"value": "string",
"vocabulary": "string",
"date_of_publication": "string"
}
],
"topic_categories": [
"string"
],
"lineage": "string",
"languages": [
"string"
],
"spatial_resolution": {
"value": 0,
"unit_of_measure": "string"
},
"inspire_uri": {
"code": "string",
"namespace": "string"
},
"inspire_limitation_access": {
"access_constraints": "string",
"other_constraints": "string",
"classification": "string"
},
"inspire_use_conditions": "string"
},
"dublin_core_element_name": {
"title": "string",
"creator": "string",
"subject": "string",
"description": "string",
"publisher": "string",
"contributor": "string",
"type": "string",
"format": "string",
"identifier": "string",
"source": "string",
"language": "string",
"bbox": {
"north": 0.1,
"south": 0.1,
"east": 0.1,
"west": 0.1
},
"date": "string",
"coverage": {},
"coverage_centroid": "string"
},
"raster_tile_url": {
"url": "string",
"id_path": "string",
"min_z": 0,
"max_z": 0,
"check_geometry": true
},
"raster_tile_width": 0,
"raster_tile_height": 0,
"filter": {
"f": [
[
{
"field": "string",
"op": "eq",
"value": "string"
}
]
],
"q": [
[
"string"
]
],
"dateformat": "string",
"righthand": true
},
"license_name": "string",
"license_urls": [
"string"
]
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful operation | CollectionReference |
| 400 | Bad Request | JSON parameter malformed. | Error |
| 404 | Not Found | Collection not found. | Error |
| 500 | Internal Server Error | Arlas Server Error. | Error |
Update a collection reference's display shape columns name attribute.
PATCH /collections/{collection}/display_names/shape_columns
Update a collection reference's display shape columns name attribute.
Body parameter
{
"property1": "string",
"property2": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| collection | path | string | true | collection |
| pretty | query | boolean | false | Pretty print |
| body | body | object | true | shapeColumnsDisplayNames |
| » additionalProperties | body | string | false | none |
Example responses
200 Response
{
"collection_name": "string",
"params": {
"index_name": "string",
"id_path": "string",
"geometry_path": "string",
"centroid_path": "string",
"timestamp_path": "string",
"exclude_fields": "string",
"update_max_hits": 0,
"taggable_fields": "string",
"exclude_wfs_fields": "string",
"custom_params": {
"property1": "string",
"property2": "string"
},
"display_names": {
"collection": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"shape_columns": {
"property1": "string",
"property2": "string"
}
},
"organisations": {
"owner": "string",
"shared": [
"string"
],
"public": true
},
"atom_feed": {
"author": {
"name": "string",
"email": "string",
"uri": "string"
},
"contributor": {
"name": "string",
"email": "string",
"uri": "string"
},
"icon": "string",
"logo": "string",
"rights": "string",
"subtitle": "string",
"generator": {
"name": "string",
"version": "string",
"uri": "string"
}
},
"open_search": {
"short_name": "string",
"description": "string",
"contact": "string",
"tags": "string",
"long_name": "string",
"image_height": "string",
"image_width": "string",
"image_type": "string",
"image_url": "string",
"developer": "string",
"attribution": "string",
"syndication_right": "string",
"adult_content": "string",
"language": "string",
"input_encoding": "string",
"output_encoding": "string"
},
"inspire": {
"keywords": [
{
"value": "string",
"vocabulary": "string",
"date_of_publication": "string"
}
],
"topic_categories": [
"string"
],
"lineage": "string",
"languages": [
"string"
],
"spatial_resolution": {
"value": 0,
"unit_of_measure": "string"
},
"inspire_uri": {
"code": "string",
"namespace": "string"
},
"inspire_limitation_access": {
"access_constraints": "string",
"other_constraints": "string",
"classification": "string"
},
"inspire_use_conditions": "string"
},
"dublin_core_element_name": {
"title": "string",
"creator": "string",
"subject": "string",
"description": "string",
"publisher": "string",
"contributor": "string",
"type": "string",
"format": "string",
"identifier": "string",
"source": "string",
"language": "string",
"bbox": {
"north": 0.1,
"south": 0.1,
"east": 0.1,
"west": 0.1
},
"date": "string",
"coverage": {},
"coverage_centroid": "string"
},
"raster_tile_url": {
"url": "string",
"id_path": "string",
"min_z": 0,
"max_z": 0,
"check_geometry": true
},
"raster_tile_width": 0,
"raster_tile_height": 0,
"filter": {
"f": [
[
{
"field": "string",
"op": "eq",
"value": "string"
}
]
],
"q": [
[
"string"
]
],
"dateformat": "string",
"righthand": true
},
"license_name": "string",
"license_urls": [
"string"
]
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful operation | CollectionReference |
| 400 | Bad Request | JSON parameter malformed. | Error |
| 404 | Not Found | Collection not found. | Error |
| 500 | Internal Server Error | Arlas Server Error. | Error |
explore
Explore API
Aggregate
POST /explore/{collection}/_aggregate
Aggregate the elements in the collection(s), given the filters and the aggregation parameters
Body parameter
{
"partitionFilter": [
{
"f": [
[
{
"field": "string",
"op": "eq",
"value": "string"
}
]
],
"q": [
[
"string"
]
],
"dateformat": "string",
"righthand": true
}
],
"filter": {
"f": [
[
{
"field": "string",
"op": "eq",
"value": "string"
}
]
],
"q": [
[
"string"
]
],
"dateformat": "string",
"righthand": true
},
"form": {
"pretty": true,
"flat": true
},
"aggregations": [
{
"type": "datehistogram",
"field": "string",
"interval": {
"value": 0,
"unit": "year"
},
"format": "string",
"metrics": [
{
"collect_field": "string",
"collect_fct": "AVG"
}
],
"order": "asc",
"on": "field",
"size": "string",
"include": "string",
"raw_geometries": [
{
"geometry": "string",
"sort": "string",
"signedSort": "string",
"include": [
"string"
]
}
],
"aggregated_geometries": [
"BBOX"
],
"fetch_hits": {
"size": 0,
"include": [
"string"
]
}
}
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| collection | path | string | true | collection |
| pretty | query | boolean | false | Pretty print |
| max-age-cache | query | integer(int32) | false | max-age-cache |
| body | body | AggregationsRequest | false | none |
Example responses
200 Response
{
"query_time": 0,
"total_time": 0,
"totalnb": 0,
"name": "string",
"count": 0,
"sumotherdoccounts": 0,
"key": {},
"key_as_string": {},
"elements": [
{
"query_time": 0,
"total_time": 0,
"totalnb": 0,
"name": "string",
"count": 0,
"sumotherdoccounts": 0,
"key": {},
"key_as_string": {},
"elements": [],
"metrics": [
{
"type": "string",
"field": "string",
"value": {}
}
],
"hits": [
{}
],
"geometries": [
{
"reference": "string",
"geometry": {
"crs": {
"type": "name",
"properties": {
"property1": {},
"property2": {}
}
},
"bbox": [
0.1
],
"type": "string"
},
"sort": "string",
"is_raw": true
}
],
"flattened_elements": {
"property1": {},
"property2": {}
}
}
],
"metrics": [
{
"type": "string",
"field": "string",
"value": {}
}
],
"hits": [
{}
],
"geometries": [
{
"reference": "string",
"geometry": {
"crs": {
"type": "name",
"properties": {
"property1": {},
"property2": {}
}
},
"bbox": [
0.1
],
"type": "string"
},
"sort": "string",
"is_raw": true
}
],
"flattened_elements": {
"property1": {},
"property2": {}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful operation | AggregationResponse |
| 400 | Bad Request | Bad request. | Error |
| 500 | Internal Server Error | Arlas Server Error. | Error |
GeoAggregate
POST /explore/{collection}/_geoaggregate
Aggregate the elements in the collection(s) as features, given the filters and the aggregation parameters.
Body parameter
{
"partitionFilter": [
{
"f": [
[
{
"field": "string",
"op": "eq",
"value": "string"
}
]
],
"q": [
[
"string"
]
],
"dateformat": "string",
"righthand": true
}
],
"filter": {
"f": [
[
{
"field": "string",
"op": "eq",
"value": "string"
}
]
],
"q": [
[
"string"
]
],
"dateformat": "string",
"righthand": true
},
"form": {
"pretty": true,
"flat": true
},
"aggregations": [
{
"type": "datehistogram",
"field": "string",
"interval": {
"value": 0,
"unit": "year"
},
"format": "string",
"metrics": [
{
"collect_field": "string",
"collect_fct": "AVG"
}
],
"order": "asc",
"on": "field",
"size": "string",
"include": "string",
"raw_geometries": [
{
"geometry": "string",
"sort": "string",
"signedSort": "string",
"include": [
"string"
]
}
],
"aggregated_geometries": [
"BBOX"
],
"fetch_hits": {
"size": 0,
"include": [
"string"
]
}
}
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| collection | path | string | true | collection |
| pretty | query | boolean | false | Pretty print |
| max-age-cache | query | integer(int32) | false | max-age-cache |
| body | body | AggregationsRequest | false | none |
Example responses
200 Response
{
"crs": {
"type": "name",
"properties": {
"property1": {},
"property2": {}
}
},
"bbox": [
0.1
],
"type": "string",
"features": [
{
"crs": {
"type": "name",
"properties": {
"property1": {},
"property2": {}
}
},
"bbox": [
0.1
],
"type": "string",
"properties": {
"property1": {},
"property2": {}
},
"geometry": {
"crs": {
"type": "name",
"properties": {
"property1": {},
"property2": {}
}
},
"bbox": [
0.1
],
"type": "string"
},
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful operation | FeatureCollection |
| 400 | Bad Request | Bad request. | Error |
| 500 | Internal Server Error | Arlas Server Error. | Error |
| 501 | Not Implemented | Not implemented functionality. | Error |
GeoAggregate on a geohash
GET /explore/{collection}/_geoaggregate/{geohash}
Aggregate the elements in the collection(s) and localized in the given geohash as features, given the filters and the aggregation parameters.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| collection | path | string | true | collection |
| geohash | path | string | true | geohash |
| agg | query | array[string] | false | - The agg parameter should be given in the following formats: |
| f | query | array[string] | false | - A triplet for filtering the result. Multiple filter can be provided in distinct parameters (AND operator is applied) or in the same parameter separated by semi-colons (OR operator is applied). The order does not matter. |
| q | query | array[string] | false | A full text search. Optionally, it's possible to search on a field using this syntax: {fieldname}:{text} |
| dateformat | query | string | false | The format of dates. This parameter should be set only if a date field is queried in f param; when using gt, lt, gte, lte and range operations |
| righthand | query | boolean | false | If righthand = true, the passed WKT should be counter clock-wise; otherwise, ARLAS-server will attempt to parse it as the "Complementary" Polygon on the other facet of the planet. |
| pretty | query | boolean | false | Pretty print |
| flat | query | boolean | false | Flats the property map: only key/value on one level |
| max-age-cache | query | integer(int32) | false | max-age-cache |
Detailed descriptions
agg: - The agg parameter should be given in the following formats:
{type}:{field}:interval-{interval}:format-{format}:collect_field-{collect_field}:collect_fct-{function}:order-{order}:on-{on}:size-{size}:raw_geometries-{raw_geometries values}:aggregated_geometries-{aggregated_geometries values}:fetch_hits-{fetch_hits values}
Where :
-
{type}:{field} part is mandatory.
-
interval must be specified only when aggregation type is datehistogram, histogram, geotile and geohash.
-
format is optional for datehistogram, and must not be specified for the other types.
-
(collect_field,collect_fct) couple is optional for all aggregation types.
-
(order,on) couple is optional for all aggregation types.
-
size is optional for term and geohash/geotile, and must not be specified for the other types.
-
include is optional for term, and must not be specified for the other types.
-
{type} possible values are :
geohash, geotile, datehistogram, histogram and term. geohash or geotile must be the main aggregation.
-
{interval} possible values depends on {type}.
If {type} = datehistogram, then {interval} = {size}(year,quarter,month,week,day,hour,minute,second). Size value must be equal to 1 for year,quarter,month and week unities.
If {type} = histogram, then {interval} = {size}.
If {type} = geohash, then {interval} = {size}. It's an integer between 1 and 12. Lower the length, greater is the surface of aggregation.
If {type} = geotile, then {interval} = {size}. It's an integer corresponding to zoom level of the aggregation, that should be larger than or equal to {z} in the path param, and no bigger than {z}+6 (max 29).
If {type} = term, then interval-{interval} is not needed.
-
format-{format} is the date format for key aggregation. The default value is yyyy-MM-dd-hh:mm:ss.
-
{collect_fct} is the aggregation function to apply to collections on the specified {collect_field}.
{collect_fct} possible values are :
avg,cardinality,max,min,sum,geobbox,geocentroid
-
(collect_field,collect_fct) should both be specified, except when collect_fct =
geobboxorgeocentroid, it could be specified alone. The metricsgeobboxandgeocentroidare returned as features collections. -
{order} is set to sort the aggregation buckets on the field name, on the count of the buckets or on the the result of a metric sub-aggregation. Its values are 'asc' or 'desc'.
-
{on} is set to specify whether the {order} is on the field name, on the count of the aggregation or on the result of a metric sub-aggregation. Its values are 'field', 'count' or 'result'.
-
When {on} =
result, then (collect_field,collect_fct) should be specified. Except when {collect_fct} =geobboxorgeocentroid, then {on}=resultis prohibited -
{size} Defines how many buckets should be returned.
-
{include} Specifies the values for which buckets will be created. This values are comma separated. If one value is specified then regular expressions can be used (only in this case) and buckets matching them will be created. If more than one value are specified then only buckets matching the exact values will be created.
-
aggregated_geometries
What it does: Allows to specify a list of aggregated forms of geometries that represent the bucket.
Syntax:
aggregated_geometries-{COMMA_SEPARATED_AGGREGATED_GEOMETRIES}.Available aggregated geometries:
centroid, bbox, cell, cell_center.-
centroid: returns the centroid of data inside the bucket.
-
bbox: returns the data extent (bbox) in each bucket.
-
cell: returns the cell (zxy or geohash) extent of each bucket. This form is supported for geohash and geotile aggregation type only.
-
cell_center: returns the cell center of each bucket. This form is supported for geohash and geotile aggregation type only.
Response: Each bucket of the aggregation will be represented with as many features (in a feature collection) as there are specified aggregated geometries. The properties of each feature has :
-
geometry_ref attribute that informs which aggregated form is returned
-
geometry_type attribute set to aggregated
Example:
aggregated_geometries-bbox,geohash -
-
raw_geometries
What it does: Allows to specify a list of raw geometries provided by hits that represent the bucket and that are elected by a sort
Syntax:
raw_geometries-{GEOMETRY_FIELD}({COMMA_SEPERATED_SORT_FIELDS});{GEOMETRY_FIELD2}({COMMA_SEPERATED_SORT_FIELDS2}).Available raw geometries: any field of the collection whose type is geo-point or geo-shape.
-
sort fields are optional. If no sort is specified, an ascending sort on
collection.params.timestamp_pathis applied -
a sort field can be preceded by '-' for descending sort. Otherwise the sort is ascending
Response: each bucket of the aggregation will be represented with as many features (in a feature collection) as there are specified raw geometries. The properties of each feature has :
-
geometry_ref attribute that informs which geometry path is returned
-
geometry_type attribute set to raw
-
geometry_sort attribute that informs how the geometry path is fetched (with what sort)
Example:
raw_geometries-geo_field1,geo_field2 || raw_geometries-geo_field(-field1,field2)|| raw_geometries-geo_field1(field1);geo_field2(field2,field3) -
-
fetch_hits
What it does: Specifies the number of hits to retrieve inside each aggregation bucket and which fields to include in the hits.
Syntax:
fetch_hits-{sizeOfHitsToFetch}(+{field1}, {field2}, -{field3}, ...).Note 1:
{sizeOfHitsToFetch}is optional, if not specified, 1 is considered as default.Note 2:
{field}can be preceded by + or - for ascending or descending sort of the hits. Order matters.Example:
fetch_hits-3(-timestamp, geometry). Fetches the 3 last positions for each bucket.
agg parameter is multiple. The first (main) aggregation must be geohash or geotile. Every agg parameter specified is a subaggregation of the previous one : order matters.
For more details, check https://github.com/gisaia/ARLAS-server/blob/master/docs/arlas-api-exploration.md
f: - A triplet for filtering the result. Multiple filter can be provided in distinct parameters (AND operator is applied) or in the same parameter separated by semi-colons (OR operator is applied). The order does not matter.
- A triplet is composed of a field name, a comparison operator and a value.
The possible values of the comparison operator are :
Operator -- Description -- value type
:eq: -- {fieldName} equals {comma separated values}. **OR** operation is applied for the specified values -- numeric or strings
:ne: -- {fieldName} must not equal {comma separated values }. **AND** operation is applied for the specified values -- numeric or strings
:like: -- {fieldName} is like {value} -- numeric or strings
:gte: -- {fieldName} is greater than or equal to {value} -- numeric
:gt: -- {fieldName} is greater than {value} -- numeric
:lte: -- {fieldName} is less than or equal to {value} -- numeric
:lt: -- {fieldName} is less than {value} -- numeric
:range: -- {fieldName} is between `{comma separated [min<max] values}`. **OR** operation is applied for the specified ranges -- numeric or strings. If the field's type is date, then min & max should be timestamps in millisecond or a Date expression
:within: -- {GeofieldName}` is within the `{given WKT string or the given BBOX }` -- a WKT string or the BBOX string : `"west, south, east, north"`
:notwithin: -- {GeofieldName} is not within the `{given WKT string or the given BBOX }` -- a WKT string or the BBOX string : `"west, south, east, north"`
:intersects: -- {GeofieldName} intersects the `{given WKT string or the given BBOX }` | a WKT string or the BBOX string : `"west, south, east, north"`
:notintersects: -- {GeofieldName} does not intersect the `{given WKT string or the given }` -- a WKT string or the BBOX string : `"west, south, east, north"`
righthand: If righthand = true, the passed WKT should be counter clock-wise; otherwise, ARLAS-server will attempt to parse it as the "Complementary" Polygon on the other facet of the planet. Inversely, If righthand = false, the passed WKT should be clock-wise; otherwise, ARLAS-server will attempt to parse it as the "Complementary" Polygon on the other facet of the planet.
Example responses
200 Response
{
"crs": {
"type": "name",
"properties": {
"property1": {},
"property2": {}
}
},
"bbox": [
0.1
],
"type": "string",
"features": [
{
"crs": {
"type": "name",
"properties": {
"property1": {},
"property2": {}
}
},
"bbox": [
0.1
],
"type": "string",
"properties": {
"property1": {},
"property2": {}
},
"geometry": {
"crs": {
"type": "name",
"properties": {
"property1": {},
"property2": {}
}
},
"bbox": [
0.1
],
"type": "string"
},
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful operation | FeatureCollection |
| 400 | Bad Request | Bad request. | Error |
| 500 | Internal Server Error | Arlas Server Error. | Error |
| 501 | Not Implemented | Not implemented functionality. | Error |
GeoAggregate on a geotile
GET /explore/{collection}/_geoaggregate/{z}/{x}/{y}
Aggregate the elements in the collection(s) and localized in the given tile as features, given the filters and the aggregation parameters.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| collection | path | string | true | collection |
| z | path | integer(int32) | true | z |
| x | path | integer(int32) | true | x |
| y | path | integer(int32) | true | y |
| agg | query | array[string] | false | - The agg parameter should be given in the following formats: |
| f | query | array[string] | false | - A triplet for filtering the result. Multiple filter can be provided in distinct parameters (AND operator is applied) or in the same parameter separated by semi-colons (OR operator is applied). The order does not matter. |
| q | query | array[string] | false | A full text search. Optionally, it's possible to search on a field using this syntax: {fieldname}:{text} |
| dateformat | query | string | false | The format of dates. This parameter should be set only if a date field is queried in f param; when using gt, lt, gte, lte and range operations |
| righthand | query | boolean | false | If righthand = true, the passed WKT should be counter clock-wise; otherwise, ARLAS-server will attempt to parse it as the "Complementary" Polygon on the other facet of the planet. |
| pretty | query | boolean | false | Pretty print |
| flat | query | boolean | false | Flats the property map: only key/value on one level |
| max-age-cache | query | integer(int32) | false | max-age-cache |
Detailed descriptions
agg: - The agg parameter should be given in the following formats:
{type}:{field}:interval-{interval}:format-{format}:collect_field-{collect_field}:collect_fct-{function}:order-{order}:on-{on}:size-{size}:raw_geometries-{raw_geometries values}:aggregated_geometries-{aggregated_geometries values}:fetch_hits-{fetch_hits values}
Where :
-
{type}:{field} part is mandatory.
-
interval must be specified only when aggregation type is datehistogram, histogram, geotile and geohash.
-
format is optional for datehistogram, and must not be specified for the other types.
-
(collect_field,collect_fct) couple is optional for all aggregation types.
-
(order,on) couple is optional for all aggregation types.
-
size is optional for term and geohash/geotile, and must not be specified for the other types.
-
include is optional for term, and must not be specified for the other types.
-
{type} possible values are :
geohash, geotile, datehistogram, histogram and term. geohash or geotile must be the main aggregation.
-
{interval} possible values depends on {type}.
If {type} = datehistogram, then {interval} = {size}(year,quarter,month,week,day,hour,minute,second). Size value must be equal to 1 for year,quarter,month and week unities.
If {type} = histogram, then {interval} = {size}.
If {type} = geohash, then {interval} = {size}. It's an integer between 1 and 12. Lower the length, greater is the surface of aggregation.
If {type} = geotile, then {interval} = {size}. It's an integer corresponding to zoom level of the aggregation, that should be larger than or equal to {z} in the path param, and no bigger than {z}+6 (max 29).
If {type} = term, then interval-{interval} is not needed.
-
format-{format} is the date format for key aggregation. The default value is yyyy-MM-dd-hh:mm:ss.
-
{collect_fct} is the aggregation function to apply to collections on the specified {collect_field}.
{collect_fct} possible values are :
avg,cardinality,max,min,sum,geobbox,geocentroid
-
(collect_field,collect_fct) should both be specified, except when collect_fct =
geobboxorgeocentroid, it could be specified alone. The metricsgeobboxandgeocentroidare returned as features collections. -
{order} is set to sort the aggregation buckets on the field name, on the count of the buckets or on the the result of a metric sub-aggregation. Its values are 'asc' or 'desc'.
-
{on} is set to specify whether the {order} is on the field name, on the count of the aggregation or on the result of a metric sub-aggregation. Its values are 'field', 'count' or 'result'.
-
When {on} =
result, then (collect_field,collect_fct) should be specified. Except when {collect_fct} =geobboxorgeocentroid, then {on}=resultis prohibited -
{size} Defines how many buckets should be returned.
-
{include} Specifies the values for which buckets will be created. This values are comma separated. If one value is specified then regular expressions can be used (only in this case) and buckets matching them will be created. If more than one value are specified then only buckets matching the exact values will be created.
-
aggregated_geometries
What it does: Allows to specify a list of aggregated forms of geometries that represent the bucket.
Syntax:
aggregated_geometries-{COMMA_SEPARATED_AGGREGATED_GEOMETRIES}.Available aggregated geometries:
centroid, bbox, cell, cell_center.-
centroid: returns the centroid of data inside the bucket.
-
bbox: returns the data extent (bbox) in each bucket.
-
cell: returns the cell (zxy or geohash) extent of each bucket. This form is supported for geohash and geotile aggregation type only.
-
cell_center: returns the cell center of each bucket. This form is supported for geohash and geotile aggregation type only.
Response: Each bucket of the aggregation will be represented with as many features (in a feature collection) as there are specified aggregated geometries. The properties of each feature has :
-
geometry_ref attribute that informs which aggregated form is returned
-
geometry_type attribute set to aggregated
Example:
aggregated_geometries-bbox,geohash -
-
raw_geometries
What it does: Allows to specify a list of raw geometries provided by hits that represent the bucket and that are elected by a sort
Syntax:
raw_geometries-{GEOMETRY_FIELD}({COMMA_SEPERATED_SORT_FIELDS});{GEOMETRY_FIELD2}({COMMA_SEPERATED_SORT_FIELDS2}).Available raw geometries: any field of the collection whose type is geo-point or geo-shape.
-
sort fields are optional. If no sort is specified, an ascending sort on
collection.params.timestamp_pathis applied -
a sort field can be preceded by '-' for descending sort. Otherwise the sort is ascending
Response: each bucket of the aggregation will be represented with as many features (in a feature collection) as there are specified raw geometries. The properties of each feature has :
-
geometry_ref attribute that informs which geometry path is returned
-
geometry_type attribute set to raw
-
geometry_sort attribute that informs how the geometry path is fetched (with what sort)
Example:
raw_geometries-geo_field1,geo_field2 || raw_geometries-geo_field(-field1,field2)|| raw_geometries-geo_field1(field1);geo_field2(field2,field3) -
-
fetch_hits
What it does: Specifies the number of hits to retrieve inside each aggregation bucket and which fields to include in the hits.
Syntax:
fetch_hits-{sizeOfHitsToFetch}(+{field1}, {field2}, -{field3}, ...).Note 1:
{sizeOfHitsToFetch}is optional, if not specified, 1 is considered as default.Note 2:
{field}can be preceded by + or - for ascending or descending sort of the hits. Order matters.Example:
fetch_hits-3(-timestamp, geometry). Fetches the 3 last positions for each bucket.
agg parameter is multiple. The first (main) aggregation must be geohash or geotile. Every agg parameter specified is a subaggregation of the previous one : order matters.
For more details, check https://github.com/gisaia/ARLAS-server/blob/master/docs/arlas-api-exploration.md
f: - A triplet for filtering the result. Multiple filter can be provided in distinct parameters (AND operator is applied) or in the same parameter separated by semi-colons (OR operator is applied). The order does not matter.
- A triplet is composed of a field name, a comparison operator and a value.
The possible values of the comparison operator are :
Operator -- Description -- value type
:eq: -- {fieldName} equals {comma separated values}. **OR** operation is applied for the specified values -- numeric or strings
:ne: -- {fieldName} must not equal {comma separated values }. **AND** operation is applied for the specified values -- numeric or strings
:like: -- {fieldName} is like {value} -- numeric or strings
:gte: -- {fieldName} is greater than or equal to {value} -- numeric
:gt: -- {fieldName} is greater than {value} -- numeric
:lte: -- {fieldName} is less than or equal to {value} -- numeric
:lt: -- {fieldName} is less than {value} -- numeric
:range: -- {fieldName} is between `{comma separated [min<max] values}`. **OR** operation is applied for the specified ranges -- numeric or strings. If the field's type is date, then min & max should be timestamps in millisecond or a Date expression
:within: -- {GeofieldName}` is within the `{given WKT string or the given BBOX }` -- a WKT string or the BBOX string : `"west, south, east, north"`
:notwithin: -- {GeofieldName} is not within the `{given WKT string or the given BBOX }` -- a WKT string or the BBOX string : `"west, south, east, north"`
:intersects: -- {GeofieldName} intersects the `{given WKT string or the given BBOX }` | a WKT string or the BBOX string : `"west, south, east, north"`
:notintersects: -- {GeofieldName} does not intersect the `{given WKT string or the given }` -- a WKT string or the BBOX string : `"west, south, east, north"`
righthand: If righthand = true, the passed WKT should be counter clock-wise; otherwise, ARLAS-server will attempt to parse it as the "Complementary" Polygon on the other facet of the planet. Inversely, If righthand = false, the passed WKT should be clock-wise; otherwise, ARLAS-server will attempt to parse it as the "Complementary" Polygon on the other facet of the planet.
Example responses
200 Response
{
"crs": {
"type": "name",
"properties": {
"property1": {},
"property2": {}
}
},
"bbox": [
0.1
],
"type": "string",
"features": [
{
"crs": {
"type": "name",
"properties": {
"property1": {},
"property2": {}
}
},
"bbox": [
0.1
],
"type": "string",
"properties": {
"property1": {},
"property2": {}
},
"geometry": {
"crs": {
"type": "name",
"properties": {
"property1": {},
"property2": {}
}
},
"bbox": [
0.1
],
"type": "string"
},
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful operation | FeatureCollection |
| 400 | Bad Request | Bad request. | Error |
| 500 | Internal Server Error | Arlas Server Error. | Error |
| 501 | Not Implemented | Not implemented functionality. | Error |
ShapeAggregate
POST /explore/{collection}/_shapeaggregate
Aggregate the elements in the collection(s) as features, given the filters and the aggregation parameters, and returns a shapefile of it.
Body parameter
{
"partitionFilter": [
{
"f": [
[
{
"field": "string",
"op": "eq",
"value": "string"
}
]
],
"q": [
[
"string"
]
],
"dateformat": "string",
"righthand": true
}
],
"filter": {
"f": [
[
{
"field": "string",
"op": "eq",
"value": "string"
}
]
],
"q": [
[
"string"
]
],
"dateformat": "string",
"righthand": true
},
"form": {
"pretty": true,
"flat": true
},
"aggregations": [
{
"type": "datehistogram",
"field": "string",
"interval": {
"value": 0,
"unit": "year"
},
"format": "string",
"metrics": [
{
"collect_field": "string",
"collect_fct": "AVG"
}
],
"order": "asc",
"on": "field",
"size": "string",
"include": "string",
"raw_geometries": [
{
"geometry": "string",
"sort": "string",
"signedSort": "string",
"include": [
"string"
]
}
],
"aggregated_geometries": [
"BBOX"
],
"fetch_hits": {
"size": 0,
"include": [
"string"
]
}
}
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| collection | path | string | true | collection |
| pretty | query | boolean | false | Pretty print |
| max-age-cache | query | integer(int32) | false | max-age-cache |
| body | body | AggregationsRequest | false | none |
Example responses
400 Response
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful operation | None |
| 400 | Bad Request | Bad request. | Error |
| 500 | Internal Server Error | Arlas Server Error. | Error |
| 501 | Not Implemented | Not implemented functionality. | Error |
Compute
POST /explore/{collection}/_compute
Computes the given metric on a field in the collection, given the filters
Body parameter
{
"partitionFilter": [
{
"f": [
[
{
"field": "string",
"op": "eq",
"value": "string"
}
]
],
"q": [
[
"string"
]
],
"dateformat": "string",
"righthand": true
}
],
"filter": {
"f": [
[
{
"field": "string",
"op": "eq",
"value": "string"
}
]
],
"q": [
[
"string"
]
],
"dateformat": "string",
"righthand": true
},
"form": {
"pretty": true,
"flat": true
},
"field": "string",
"metric": "AVG"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| collection | path | string | true | collection |
| pretty | query | boolean | false | Pretty print |
| max-age-cache | query | integer(int32) | false | max-age-cache |
| body | body | ComputationRequest | false | none |
Example responses
200 Response
{
"query_time": 0,
"total_time": 0,
"totalnb": 0,
"field": "string",
"metric": "AVG",
"value": 0.1,
"geometry": {
"crs": {
"type": "name",
"properties": {
"property1": {},
"property2": {}
}
},
"bbox": [
0.1
],
"type": "string"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful operation | ComputationResponse |
| 400 | Bad Request | Bad request. | Error |
| 500 | Internal Server Error | Arlas Server Error. | Error |
Count
POST /explore/{collection}/_count
Count the number of elements found in the collection(s), given the filters
Body parameter
{
"partitionFilter": [
{
"f": [
[
{
"field": "string",
"op": "eq",
"value": "string"
}
]
],
"q": [
[
"string"
]
],
"dateformat": "string",
"righthand": true
}
],
"filter": {
"f": [
[
{
"field": "string",
"op": "eq",
"value": "string"
}
]
],
"q": [
[
"string"
]
],
"dateformat": "string",
"righthand": true
},
"form": {
"pretty": true,
"flat": true
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| collection | path | string | true | collections |
| pretty | query | boolean | false | Pretty print |
| body | body | Count | false | none |
Example responses
200 Response
{
"collection": "string",
"hits": [
{
"md": {
"id": "string",
"timestamp": 0,
"geometry": {
"crs": {
"type": "name",
"properties": {
"property1": {},
"property2": {}
}
},
"bbox": [
0.1
],
"type": "string"
},
"centroid": {
"crs": {
"type": "name",
"properties": {
"property1": {},
"property2": {}
}
},
"bbox": [
0.1
],
"type": "string"
},
"returned_geometries": [
{
"path": "string",
"geometry": {
"crs": {
"type": "name",
"properties": {
"property1": {},
"property2": {}
}
},
"bbox": [
0.1
],
"type": "string"
}
}
]
},
"data": {}
}
],
"nbhits": 0,
"totalnb": 0,
"links": {
"property1": {
"href": "string",
"method": "string",
"body": {}
},
"property2": {
"href": "string",
"method": "string",
"body": {}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful operation | Hits |
| 400 | Bad Request | Bad request. | Error |
| 500 | Internal Server Error | Arlas Server Error. | Error |
Describe
GET /explore/{collection}/_describe
Describe the structure and the content of the given collection.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| collection | path | string | true | collection |
| pretty | query | boolean | false | Pretty print |
| max-age-cache | query | integer(int32) | false | max-age-cache |
Example responses
200 Response
{
"properties": {
"property1": {
"type": "TEXT",
"format": "string",
"hash_field": "string",
"properties": {
"property1": {},
"property2": {}
},
"taggable": true,
"indexed": true
},
"property2": {
"type": "TEXT",
"format": "string",
"hash_field": "string",
"properties": {
"property1": {},
"property2": {}
},
"taggable": true,
"indexed": true
}
},
"collection_name": "string",
"params": {
"index_name": "string",
"id_path": "string",
"geometry_path": "string",
"centroid_path": "string",
"timestamp_path": "string",
"exclude_fields": "string",
"update_max_hits": 0,
"taggable_fields": "string",
"exclude_wfs_fields": "string",
"custom_params": {
"property1": "string",
"property2": "string"
},
"display_names": {
"collection": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"shape_columns": {
"property1": "string",
"property2": "string"
}
},
"organisations": {
"owner": "string",
"shared": [
"string"
],
"public": true
},
"atom_feed": {
"author": {
"name": "string",
"email": "string",
"uri": "string"
},
"contributor": {
"name": "string",
"email": "string",
"uri": "string"
},
"icon": "string",
"logo": "string",
"rights": "string",
"subtitle": "string",
"generator": {
"name": "string",
"version": "string",
"uri": "string"
}
},
"open_search": {
"short_name": "string",
"description": "string",
"contact": "string",
"tags": "string",
"long_name": "string",
"image_height": "string",
"image_width": "string",
"image_type": "string",
"image_url": "string",
"developer": "string",
"attribution": "string",
"syndication_right": "string",
"adult_content": "string",
"language": "string",
"input_encoding": "string",
"output_encoding": "string"
},
"inspire": {
"keywords": [
{
"value": "string",
"vocabulary": "string",
"date_of_publication": "string"
}
],
"topic_categories": [
"string"
],
"lineage": "string",
"languages": [
"string"
],
"spatial_resolution": {
"value": 0,
"unit_of_measure": "string"
},
"inspire_uri": {
"code": "string",
"namespace": "string"
},
"inspire_limitation_access": {
"access_constraints": "string",
"other_constraints": "string",
"classification": "string"
},
"inspire_use_conditions": "string"
},
"dublin_core_element_name": {
"title": "string",
"creator": "string",
"subject": "string",
"description": "string",
"publisher": "string",
"contributor": "string",
"type": "string",
"format": "string",
"identifier": "string",
"source": "string",
"language": "string",
"bbox": {
"north": 0.1,
"south": 0.1,
"east": 0.1,
"west": 0.1
},
"date": "string",
"coverage": {},
"coverage_centroid": "string"
},
"raster_tile_url": {
"url": "string",
"id_path": "string",
"min_z": 0,
"max_z": 0,
"check_geometry": true
},
"raster_tile_width": 0,
"raster_tile_height": 0,
"filter": {
"f": [
[
{
"field": "string",
"op": "eq",
"value": "string"
}
]
],
"q": [
[
"string"
]
],
"dateformat": "string",
"righthand": true
},
"license_name": "string",
"license_urls": [
"string"
]
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful operation | CollectionReferenceDescription |
| 400 | Bad Request | Bad request. | Error |
| 403 | Forbidden | Collection not authorized. | Error |
| 500 | Internal Server Error | Arlas Server Error. | Error |
List
GET /explore/_list
List the collections configured in ARLAS.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| pretty | query | boolean | false | Pretty print |
| max-age-cache | query | integer(int32) | false | max-age-cache |
Example responses
200 Response
[
{
"properties": {
"property1": {
"type": "TEXT",
"format": "string",
"hash_field": "string",
"properties": {
"property1": {},
"property2": {}
},
"taggable": true,
"indexed": true
},
"property2": {
"type": "TEXT",
"format": "string",
"hash_field": "string",
"properties": {
"property1": {},
"property2": {}
},
"taggable": true,
"indexed": true
}
},
"collection_name": "string",
"params": {
"index_name": "string",
"id_path": "string",
"geometry_path": "string",
"centroid_path": "string",
"timestamp_path": "string",
"exclude_fields": "string",
"update_max_hits": 0,
"taggable_fields": "string",
"exclude_wfs_fields": "string",
"custom_params": {
"property1": "string",
"property2": "string"
},
"display_names": {
"collection": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"shape_columns": {
"property1": "string",
"property2": "string"
}
},
"organisations": {
"owner": "string",
"shared": [
"string"
],
"public": true
},
"atom_feed": {
"author": {
"name": "string",
"email": "string",
"uri": "string"
},
"contributor": {
"name": "string",
"email": "string",
"uri": "string"
},
"icon": "string",
"logo": "string",
"rights": "string",
"subtitle": "string",
"generator": {
"name": "string",
"version": "string",
"uri": "string"
}
},
"open_search": {
"short_name": "string",
"description": "string",
"contact": "string",
"tags": "string",
"long_name": "string",
"image_height": "string",
"image_width": "string",
"image_type": "string",
"image_url": "string",
"developer": "string",
"attribution": "string",
"syndication_right": "string",
"adult_content": "string",
"language": "string",
"input_encoding": "string",
"output_encoding": "string"
},
"inspire": {
"keywords": [
{
"value": "string",
"vocabulary": "string",
"date_of_publication": "string"
}
],
"topic_categories": [
"string"
],
"lineage": "string",
"languages": [
"string"
],
"spatial_resolution": {
"value": 0,
"unit_of_measure": "string"
},
"inspire_uri": {
"code": "string",
"namespace": "string"
},
"inspire_limitation_access": {
"access_constraints": "string",
"other_constraints": "string",
"classification": "string"
},
"inspire_use_conditions": "string"
},
"dublin_core_element_name": {
"title": "string",
"creator": "string",
"subject": "string",
"description": "string",
"publisher": "string",
"contributor": "string",
"type": "string",
"format": "string",
"identifier": "string",
"source": "string",
"language": "string",
"bbox": {
"north": 0.1,
"south": 0.1,
"east": 0.1,
"west": 0.1
},
"date": "string",
"coverage": {},
"coverage_centroid": "string"
},
"raster_tile_url": {
"url": "string",
"id_path": "string",
"min_z": 0,
"max_z": 0,
"check_geometry": true
},
"raster_tile_width": 0,
"raster_tile_height": 0,
"filter": {
"f": [
[
{
"field": "string",
"op": "eq",
"value": "string"
}
]
],
"q": [
[
"string"
]
],
"dateformat": "string",
"righthand": true
},
"license_name": "string",
"license_urls": [
"string"
]
}
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful operation | Inline |
| 400 | Bad Request | Bad request. | Error |
| 403 | Forbidden | Collection not authorized. | Error |
| 500 | Internal Server Error | Arlas Server Error. | Error |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [CollectionReferenceDescription] | false | none | none |
| » properties | object | false | none | none |
| »» additionalProperties | CollectionReferenceDescriptionProperty | false | none | none |
| »»» type | string | false | none | none |
| »»» format | string | false | none | none |
| »»» hash_field | string | false | none | none |
| »»» properties | CollectionReferenceDescriptionProperty | false | none | none |
| »»»» additionalProperties | CollectionReferenceDescriptionProperty | false | none | none |
| »»» taggable | boolean | false | none | none |
| »»» indexed | boolean | false | none | none |
| » collection_name | string | true | none | none |
| » params | CollectionReferenceParameters | true | none | none |
| »» index_name | string | true | none | none |
| »» id_path | string | true | none | none |
| »» geometry_path | string | true | none | none |
| »» centroid_path | string | true | none | none |
| »» timestamp_path | string | true | none | none |
| »» exclude_fields | string | false | none | none |
| »» update_max_hits | integer(int32) | false | none | none |
| »» taggable_fields | string | false | none | none |
| »» exclude_wfs_fields | string | false | none | none |
| »» custom_params | object | false | none | none |
| »»» additionalProperties | string | false | none | none |
| »» display_names | CollectionDisplayNames | false | none | none |
| »»» collection | string | false | none | none |
| »»» fields | object | false | none | none |
| »»»» additionalProperties | string | false | none | none |
| »»» shape_columns | object | false | none | none |
| »»»» additionalProperties | string | false | none | none |
| »» organisations | CollectionOrganisations | false | none | none |
| »»» owner | string | false | none | none |
| »»» shared | [string] | false | none | none |
| »»» public | boolean | false | none | none |
| »» atom_feed | Feed | false | none | none |
| »»» author | Person | false | none | none |
| »»»» name | string | false | none | none |
| string | false | none | none | |
| »»»» uri | string | false | none | none |
| »»» contributor | Person | false | none | none |
| »»» icon | string | false | none | none |
| »»» logo | string | false | none | none |
| »»» rights | string | false | none | none |
| »»» subtitle | string | false | none | none |
| »»» generator | Generator | false | none | none |
| »»»» name | string | false | none | none |
| »»»» version | string | false | none | none |
| »»»» uri | string | false | none | none |
| »» open_search | OpenSearch | false | none | none |
| »»» short_name | string | false | none | none |
| »»» description | string | false | none | none |
| »»» contact | string | false | none | none |
| »»» tags | string | false | none | none |
| »»» long_name | string | false | none | none |
| »»» image_height | string | false | none | none |
| »»» image_width | string | false | none | none |
| »»» image_type | string | false | none | none |
| »»» image_url | string | false | none | none |
| »»» developer | string | false | none | none |
| »»» attribution | string | false | none | none |
| »»» syndication_right | string | false | none | none |
| »»» adult_content | string | false | none | none |
| »»» language | string | false | none | none |
| »»» input_encoding | string | false | none | none |
| »»» output_encoding | string | false | none | none |
| »» inspire | Inspire | false | none | none |
| »»» keywords | [Keyword] | false | none | none |
| »»»» value | string | false | none | none |
| »»»» vocabulary | string | false | none | none |
| »»»» date_of_publication | string | false | none | none |
| »»» topic_categories | [string] | false | none | none |
| »»» lineage | string | false | none | none |
| »»» languages | [string] | false | none | none |
| »»» spatial_resolution | InspireSpatialResolution | false | none | none |
| »»»» value | number | false | none | none |
| »»»» unit_of_measure | string | false | none | none |
| »»» inspire_uri | InspireURI | false | none | none |
| »»»» code | string | false | none | none |
| »»»» namespace | string | false | none | none |
| »»» inspire_limitation_access | InspireLimitationAccess | false | none | none |
| »»»» access_constraints | string | false | none | none |
| »»»» other_constraints | string | false | none | none |
| »»»» classification | string | false | none | none |
| »»» inspire_use_conditions | string | false | none | none |
| »» dublin_core_element_name | DublinCoreElementName | false | none | none |
| »»» title | string | false | none | none |
| »»» creator | string | false | none | none |
| »»» subject | string | false | none | none |
| »»» description | string | false | none | none |
| »»» publisher | string | false | none | none |
| »»» contributor | string | false | none | none |
| »»» type | string | false | none | none |
| »»» format | string | false | none | none |
| »»» identifier | string | false | none | none |
| »»» source | string | false | none | none |
| »»» language | string | false | none | none |
| »»» bbox | Bbox | false | none | none |
| »»»» north | number(double) | true | none | none |
| »»»» south | number(double) | true | none | none |
| »»»» east | number(double) | true | none | none |
| »»»» west | number(double) | true | none | none |
| »»» date | string | false | none | none |
| »»» coverage | object | false | none | none |
| »»» coverage_centroid | string | false | none | none |
| »» raster_tile_url | RasterTileURL | false | none | none |
| »»» url | string | true | none | none |
| »»» id_path | string | true | none | none |
| »»» min_z | integer(int32) | false | none | none |
| »»» max_z | integer(int32) | false | none | none |
| »»» check_geometry | boolean | false | none | none |
| »» raster_tile_width | integer(int32) | false | none | none |
| »» raster_tile_height | integer(int32) | false | none | none |
| »» filter | Filter | false | none | none |
| »»» f | [array] | false | none | none |
| »»»» field | string | false | none | none |
| »»»» op | string | false | none | none |
| »»»» value | string | false | none | none |
| »»»» empty | boolean | false | none | none |
| » q | [array] | false | none | none |
| »» empty | boolean | false | none | none |
| » dateformat | string | false | none | none |
| » righthand | boolean | false | none | none |
| license_name | string | false | none | none |
| license_urls | [string] | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| type | TEXT |
| type | KEYWORD |
| type | LONG |
| type | INTEGER |
| type | SHORT |
| type | BYTE |
| type | DOUBLE |
| type | FLOAT |
| type | DATE |
| type | BOOLEAN |
| type | BINARY |
| type | INT_RANGE |
| type | FLOAT_RANGE |
| type | LONG_RANGE |
| type | DOUBLE_RANGE |
| type | DATE_RANGE |
| type | OBJECT |
| type | NESTED |
| type | GEO_POINT |
| type | GEO_SHAPE |
| type | IP |
| type | COMPLETION |
| type | TOKEN_COUNT |
| type | MAPPER_MURMUR3 |
| type | UNKNOWN |
| type | VARCHAR |
| type | CHAR |
| type | CHARACTER |
| type | BIT |
| type | TINYINT |
| type | SMALLINT |
| type | INT |
| type | BIGINT |
| type | DECIMAL |
| type | NUMERIC |
| type | REAL |
| type | DOUBLEPRECISION |
| type | TIMESTAMP |
| type | TIME |
| type | INTERVAL |
| type | GEOMETRY |
| type | GEOGRAPHY |
| type | POINT |
| type | LINESTRING |
| type | POLYGON |
| type | MULTIPOINT |
| type | MULTILINESTRING |
| type | MULTIPOLYGON |
| type | GEOMETRYCOLLECTION |
| type | MURMUR3 |
| op | eq |
| op | gte |
| op | gt |
| op | lte |
| op | lt |
| op | like |
| op | ne |
| op | range |
| op | within |
| op | notwithin |
| op | intersects |
| op | notintersects |
Get an Arlas document
GET /explore/{collection}/{identifier}
Returns a raw indexed document.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| collection | path | string | true | collection |
| identifier | path | string | true | identifier |
| pretty | query | boolean | false | Pretty print |
| flat | query | boolean | false | Flats the property map: only key/value on one level |
| max-age-cache | query | integer(int32) | false | max-age-cache |
Example responses
200 Response
{
"md": {
"id": "string",
"timestamp": 0,
"geometry": {
"crs": {
"type": "name",
"properties": {
"property1": {},
"property2": {}
}
},
"bbox": [
0.1
],
"type": "string"
},
"centroid": {
"crs": {
"type": "name",
"properties": {
"property1": {},
"property2": {}
}
},
"bbox": [
0.1
],
"type": "string"
},
"returned_geometries": [
{
"path": "string",
"geometry": {
"crs": {
"type": "name",
"properties": {
"property1": {},
"property2": {}
}
},
"bbox": [
0.1
],
"type": "string"
}
}
]
},
"data": {}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful operation | ArlasHit |
| 400 | Bad Request | Bad request. | Error |
| 404 | Not Found | Not Found Error. | Error |
| 500 | Internal Server Error | Arlas Server Error. | Error |
GeoSearch
POST /explore/{collection}/_geosearch
Search and return the elements found in the collection(s) as features, given the filters
Body parameter
{
"partitionFilter": [
{
"f": [
[
{
"field": "string",
"op": "eq",
"value": "string"
}
]
],
"q": [
[
"string"
]
],
"dateformat": "string",
"righthand": true
}
],
"filter": {
"f": [
[
{
"field": "string",
"op": "eq",
"value": "string"
}
]
],
"q": [
[
"string"
]
],
"dateformat": "string",
"righthand": true
},
"form": {
"pretty": true,
"flat": true
},
"page": {
"size": 0,
"from": 0,
"sort": "string",
"after": "string",
"before": "string"
},
"projection": {
"includes": "string",
"excludes": "string"
},
"returned_geometries": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| collection | path | string | true | collection |
| pretty | query | boolean | false | Pretty print |
| max-age-cache | query | integer(int32) | false | max-age-cache |
| body | body | Search | false | none |
Example responses
200 Response
{
"crs": {
"type": "name",
"properties": {
"property1": {},
"property2": {}
}
},
"bbox": [
0.1
],
"type": "string",
"features": [
{
"crs": {
"type": "name",
"properties": {
"property1": {},
"property2": {}
}
},
"bbox": [
0.1
],
"type": "string",
"properties": {
"property1": {},
"property2": {}
},
"geometry": {
"crs": {
"type": "name",
"properties": {
"property1": {},
"property2": {}
}
},
"bbox": [
0.1
],
"type": "string"
},
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful operation | FeatureCollection |
| 400 | Bad Request | Bad request. | Error |
| 500 | Internal Server Error | Arlas Server Error. | Error |
ShapeSearch
POST /explore/{collection}/_shapesearch
Search and return the elements found in the collection(s) as features, given the filters, exported as a Shapefile
Body parameter
{
"partitionFilter": [
{
"f": [
[
{
"field": "string",
"op": "eq",
"value": "string"
}
]
],
"q": [
[
"string"
]
],
"dateformat": "string",
"righthand": true
}
],
"filter": {
"f": [
[
{
"field": "string",
"op": "eq",
"value": "string"
}
]
],
"q": [
[
"string"
]
],
"dateformat": "string",
"righthand": true
},
"form": {
"pretty": true,
"flat": true
},
"page": {
"size": 0,
"from": 0,
"sort": "string",
"after": "string",
"before": "string"
},
"projection": {
"includes": "string",
"excludes": "string"
},
"returned_geometries": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| collection | path | string | true | collection |
| pretty | query | boolean | false | Pretty print |
| max-age-cache | query | integer(int32) | false | max-age-cache |
| body | body | Search | false | none |
Example responses
400 Response
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful operation | None |
| 400 | Bad Request | Bad request. | Error |
| 500 | Internal Server Error | Arlas Server Error. | Error |
Tiled GeoSearch
GET /explore/{collection}/_tile/{z}/{x}/{y}.png
Search and return the elements found in the collection(s) and localized in the given tile(x,y,z) as features, given the filters
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| collection | path | string | true | collection |
| x | path | integer(int32) | true | x |
| y | path | integer(int32) | true | y |
| z | path | integer(int32) | true | z |
| f | query | array[string] | false | - A triplet for filtering the result. Multiple filter can be provided in distinct parameters (AND operator is applied) or in the same parameter separated by semi-colons (OR operator is applied). The order does not matter. |
| q | query | array[string] | false | A full text search. Optionally, it's possible to search on a field using this syntax: {fieldname}:{text} |
| dateformat | query | string | false | The format of dates. This parameter should be set only if a date field is queried in f param; when using gt, lt, gte, lte and range operations |
| righthand | query | boolean | false | If righthand = true, the passed WKT should be counter clock-wise; otherwise, ARLAS-server will attempt to parse it as the "Complementary" Polygon on the other facet of the planet. |
| size | query | integer(int64) | false | The maximum number of entries or sub-entries to be returned. The default value is 10 |
| from | query | integer(int64) | false | From index to start the search from. Defaults to 0. |
| sort | query | string | false | Sorts the resulted hits on the given fields and/or by distance to a given point: |
| after | query | string | false | List of values of fields present in sort param that are used to search after. |
| before | query | string | false | Same idea that after param, but to retrieve the data placed before the pointed element, given the provided order (sort). |
| sampling | query | integer(int32) | false | Size of the sampling for testing transparency: 1: test every pixel, 10: test 1 pixel every 10 pixels, etc. |
| coverage | query | integer(int32) | false | Percentage (]0-100]) of acceptable transparent pixels. Higher the percentage, more tiles could be used for filling the tile |
| max-age-cache | query | integer(int32) | false | max-age-cache |
Detailed descriptions
f: - A triplet for filtering the result. Multiple filter can be provided in distinct parameters (AND operator is applied) or in the same parameter separated by semi-colons (OR operator is applied). The order does not matter.
- A triplet is composed of a field name, a comparison operator and a value.
The possible values of the comparison operator are :
Operator -- Description -- value type
:eq: -- {fieldName} equals {comma separated values}. **OR** operation is applied for the specified values -- numeric or strings
:ne: -- {fieldName} must not equal {comma separated values }. **AND** operation is applied for the specified values -- numeric or strings
:like: -- {fieldName} is like {value} -- numeric or strings
:gte: -- {fieldName} is greater than or equal to {value} -- numeric
:gt: -- {fieldName} is greater than {value} -- numeric
:lte: -- {fieldName} is less than or equal to {value} -- numeric
:lt: -- {fieldName} is less than {value} -- numeric
:range: -- {fieldName} is between `{comma separated [min<max] values}`. **OR** operation is applied for the specified ranges -- numeric or strings. If the field's type is date, then min & max should be timestamps in millisecond or a Date expression
:within: -- {GeofieldName}` is within the `{given WKT string or the given BBOX }` -- a WKT string or the BBOX string : `"west, south, east, north"`
:notwithin: -- {GeofieldName} is not within the `{given WKT string or the given BBOX }` -- a WKT string or the BBOX string : `"west, south, east, north"`
:intersects: -- {GeofieldName} intersects the `{given WKT string or the given BBOX }` | a WKT string or the BBOX string : `"west, south, east, north"`
:notintersects: -- {GeofieldName} does not intersect the `{given WKT string or the given }` -- a WKT string or the BBOX string : `"west, south, east, north"`
righthand: If righthand = true, the passed WKT should be counter clock-wise; otherwise, ARLAS-server will attempt to parse it as the "Complementary" Polygon on the other facet of the planet. Inversely, If righthand = false, the passed WKT should be clock-wise; otherwise, ARLAS-server will attempt to parse it as the "Complementary" Polygon on the other facet of the planet.
sort: Sorts the resulted hits on the given fields and/or by distance to a given point:
Syntax:
{field1},{field2},-{field3},geodistance:{lat} {lon},{field4} ....Note 1:
{field}can be preceded by '-' for descending sort. By default, sort is ascending.Note 2: The order of fields matters.
Note 3 geodistance sort: Sorts the hits centroids by distance to the given {lat} {lon} (ascending distance sort). It can be specified at most 1 time.
Example 1: sort=
age,-timestamp. Resulted hits are sorted by age. For same age hits, they are decreasingly sorted in time.Example 2: sort=
age,geodistance:89 179. Resulted hits are sorted by age. For same age hits, they are sorted by closest distance to the point(89°,179°)
after: List of values of fields present in sort param that are used to search after.
What it does: Retrieve the data placed after the pointed element, given the provided order (sort).
Restriction 1: after param works only combined with sort param.
Syntax:
after={value1},{value2},...,{valueN} & sort={field1},{field2},...,{fieldN}.Note 1: *{value1}
and{value2}are the values of{field1}and{field2}` in the last hit returned in the previous searchNote 2: The order of fields and values matters. {value1},{value2} must be in the same order of {field1},{field2} in sort param
Note 3: The last field
{fieldN}must be the id field specified in the collection collection.params.idPath (returned as md.id) and{valueN}its corresponding value.Example: sort=
-date,id& after=01/02/2019,abcd1234. Gets the following hits of the previous search that stopped at date 01/02/2019 and id abcd1234.Restriction 2: from param must be set to 0 or kept unset
Example responses
400 Response
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful operation | None |
| 400 | Bad Request | Bad request. | Error |
| 500 | Internal Server Error | Arlas Server Error. | Error |
Search
POST /explore/{collection}/_search
Search and return the elements found in the collection, given the filters
Body parameter
{
"partitionFilter": [
{
"f": [
[
{
"field": "string",
"op": "eq",
"value": "string"
}
]
],
"q": [
[
"string"
]
],
"dateformat": "string",
"righthand": true
}
],
"filter": {
"f": [
[
{
"field": "string",
"op": "eq",
"value": "string"
}
]
],
"q": [
[
"string"
]
],
"dateformat": "string",
"righthand": true
},
"form": {
"pretty": true,
"flat": true
},
"page": {
"size": 0,
"from": 0,
"sort": "string",
"after": "string",
"before": "string"
},
"projection": {
"includes": "string",
"excludes": "string"
},
"returned_geometries": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| collection | path | string | true | collection |
| pretty | query | boolean | false | Pretty print |
| max-age-cache | query | integer(int32) | false | max-age-cache |
| body | body | Search | false | none |
Example responses
200 Response
{
"collection": "string",
"hits": [
{
"md": {
"id": "string",
"timestamp": 0,
"geometry": {
"crs": {
"type": "name",
"properties": {
"property1": {},
"property2": {}
}
},
"bbox": [
0.1
],
"type": "string"
},
"centroid": {
"crs": {
"type": "name",
"properties": {
"property1": {},
"property2": {}
}
},
"bbox": [
0.1
],
"type": "string"
},
"returned_geometries": [
{
"path": "string",
"geometry": {
"crs": {
"type": "name",
"properties": {
"property1": {},
"property2": {}
}
},
"bbox": [
0.1
],
"type": "string"
}
}
]
},
"data": {}
}
],
"nbhits": 0,
"totalnb": 0,
"links": {
"property1": {
"href": "string",
"method": "string",
"body": {}
},
"property2": {
"href": "string",
"method": "string",
"body": {}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful operation | Hits |
| 400 | Bad Request | Bad request. | Error |
| 500 | Internal Server Error | Arlas Server Error. | Error |
Suggest
GET /explore/{collections}/_suggest
Suggest the the n (n=size) most relevant terms given the filters
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| collections | path | string | true | collections, comma separated |
| f | query | array[string] | false | - A triplet for filtering the result. Multiple filter can be provided. The order does not matter. |
| q | query | string | false | A full text search |
| pretty | query | boolean | false | Pretty print |
| size | query | integer(int64) | false | The maximum number of entries or sub-entries to be returned. The default value is 10 |
| from | query | integer(int64) | false | From index to start the search from. Defaults to 0. |
| field | query | string | false | Name of the field to be used for retrieving the most relevant terms |
| max-age-cache | query | integer(int32) | false | max-age-cache |
Detailed descriptions
f: - A triplet for filtering the result. Multiple filter can be provided. The order does not matter.
- A triplet is composed of a field name, a comparison operator and a value.
The possible values of the comparison operator are :
Operator | Description | value type
: | {fieldName} equals {value} | numeric or strings
:gte: | {fieldName} is greater than or equal to {value} | numeric
:gt: | {fieldName} is greater than {value} | numeric
:lte: | {fieldName} is less than or equal to {value} | numeric
:lt: | {fieldName} is less than {value} | numeric
-
The AND operator is applied between filters having different fieldNames.
-
The OR operator is applied on filters having the same fieldName.
-
If the fieldName starts with - then a must not filter is used
-
If the fieldName starts with - then a must not filter is used
For more details, check https://gitlab.com/GISAIA.ARLAS/ARLAS-server/blob/master/doc/api/API-definition.md
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful operation | None |
Schemas
Success
{
"status": 0,
"message": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| status | integer(int32) | false | none | none |
| message | string | false | none | none |
Error
{
"status": 0,
"message": "string",
"error": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| status | integer(int32) | false | none | none |
| message | string | false | none | none |
| error | string | false | none | none |
Bbox
{
"north": 0.1,
"south": 0.1,
"east": 0.1,
"west": 0.1
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| north | number(double) | true | none | none |
| south | number(double) | true | none | none |
| east | number(double) | true | none | none |
| west | number(double) | true | none | none |
CollectionDisplayNames
{
"collection": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"shape_columns": {
"property1": "string",
"property2": "string"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| collection | string | false | none | none |
| fields | object | false | none | none |
| » additionalProperties | string | false | none | none |
| shape_columns | object | false | none | none |
| » additionalProperties | string | false | none | none |
CollectionOrganisations
{
"owner": "string",
"shared": [
"string"
],
"public": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| owner | string | false | none | none |
| shared | [string] | false | none | none |
| public | boolean | false | none | none |
CollectionReference
{
"collection_name": "string",
"params": {
"index_name": "string",
"id_path": "string",
"geometry_path": "string",
"centroid_path": "string",
"timestamp_path": "string",
"exclude_fields": "string",
"update_max_hits": 0,
"taggable_fields": "string",
"exclude_wfs_fields": "string",
"custom_params": {
"property1": "string",
"property2": "string"
},
"display_names": {
"collection": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"shape_columns": {
"property1": "string",
"property2": "string"
}
},
"organisations": {
"owner": "string",
"shared": [
"string"
],
"public": true
},
"atom_feed": {
"author": {
"name": "string",
"email": "string",
"uri": "string"
},
"contributor": {
"name": "string",
"email": "string",
"uri": "string"
},
"icon": "string",
"logo": "string",
"rights": "string",
"subtitle": "string",
"generator": {
"name": "string",
"version": "string",
"uri": "string"
}
},
"open_search": {
"short_name": "string",
"description": "string",
"contact": "string",
"tags": "string",
"long_name": "string",
"image_height": "string",
"image_width": "string",
"image_type": "string",
"image_url": "string",
"developer": "string",
"attribution": "string",
"syndication_right": "string",
"adult_content": "string",
"language": "string",
"input_encoding": "string",
"output_encoding": "string"
},
"inspire": {
"keywords": [
{
"value": "string",
"vocabulary": "string",
"date_of_publication": "string"
}
],
"topic_categories": [
"string"
],
"lineage": "string",
"languages": [
"string"
],
"spatial_resolution": {
"value": 0,
"unit_of_measure": "string"
},
"inspire_uri": {
"code": "string",
"namespace": "string"
},
"inspire_limitation_access": {
"access_constraints": "string",
"other_constraints": "string",
"classification": "string"
},
"inspire_use_conditions": "string"
},
"dublin_core_element_name": {
"title": "string",
"creator": "string",
"subject": "string",
"description": "string",
"publisher": "string",
"contributor": "string",
"type": "string",
"format": "string",
"identifier": "string",
"source": "string",
"language": "string",
"bbox": {
"north": 0.1,
"south": 0.1,
"east": 0.1,
"west": 0.1
},
"date": "string",
"coverage": {},
"coverage_centroid": "string"
},
"raster_tile_url": {
"url": "string",
"id_path": "string",
"min_z": 0,
"max_z": 0,
"check_geometry": true
},
"raster_tile_width": 0,
"raster_tile_height": 0,
"filter": {
"f": [
[
{
"field": "string",
"op": "eq",
"value": "string"
}
]
],
"q": [
[
"string"
]
],
"dateformat": "string",
"righthand": true
},
"license_name": "string",
"license_urls": [
"string"
]
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| collection_name | string | true | none | none |
| params | CollectionReferenceParameters | true | none | none |
CollectionReferenceParameters
{
"index_name": "string",
"id_path": "string",
"geometry_path": "string",
"centroid_path": "string",
"timestamp_path": "string",
"exclude_fields": "string",
"update_max_hits": 0,
"taggable_fields": "string",
"exclude_wfs_fields": "string",
"custom_params": {
"property1": "string",
"property2": "string"
},
"display_names": {
"collection": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"shape_columns": {
"property1": "string",
"property2": "string"
}
},
"organisations": {
"owner": "string",
"shared": [
"string"
],
"public": true
},
"atom_feed": {
"author": {
"name": "string",
"email": "string",
"uri": "string"
},
"contributor": {
"name": "string",
"email": "string",
"uri": "string"
},
"icon": "string",
"logo": "string",
"rights": "string",
"subtitle": "string",
"generator": {
"name": "string",
"version": "string",
"uri": "string"
}
},
"open_search": {
"short_name": "string",
"description": "string",
"contact": "string",
"tags": "string",
"long_name": "string",
"image_height": "string",
"image_width": "string",
"image_type": "string",
"image_url": "string",
"developer": "string",
"attribution": "string",
"syndication_right": "string",
"adult_content": "string",
"language": "string",
"input_encoding": "string",
"output_encoding": "string"
},
"inspire": {
"keywords": [
{
"value": "string",
"vocabulary": "string",
"date_of_publication": "string"
}
],
"topic_categories": [
"string"
],
"lineage": "string",
"languages": [
"string"
],
"spatial_resolution": {
"value": 0,
"unit_of_measure": "string"
},
"inspire_uri": {
"code": "string",
"namespace": "string"
},
"inspire_limitation_access": {
"access_constraints": "string",
"other_constraints": "string",
"classification": "string"
},
"inspire_use_conditions": "string"
},
"dublin_core_element_name": {
"title": "string",
"creator": "string",
"subject": "string",
"description": "string",
"publisher": "string",
"contributor": "string",
"type": "string",
"format": "string",
"identifier": "string",
"source": "string",
"language": "string",
"bbox": {
"north": 0.1,
"south": 0.1,
"east": 0.1,
"west": 0.1
},
"date": "string",
"coverage": {},
"coverage_centroid": "string"
},
"raster_tile_url": {
"url": "string",
"id_path": "string",
"min_z": 0,
"max_z": 0,
"check_geometry": true
},
"raster_tile_width": 0,
"raster_tile_height": 0,
"filter": {
"f": [
[
{
"field": "string",
"op": "eq",
"value": "string"
}
]
],
"q": [
[
"string"
]
],
"dateformat": "string",
"righthand": true
},
"license_name": "string",
"license_urls": [
"string"
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| index_name | string | true | none | none |
| id_path | string | true | none | none |
| geometry_path | string | true | none | none |
| centroid_path | string | true | none | none |
| timestamp_path | string | true | none | none |
| exclude_fields | string | false | none | none |
| update_max_hits | integer(int32) | false | none | none |
| taggable_fields | string | false | none | none |
| exclude_wfs_fields | string | false | none | none |
| custom_params | object | false | none | none |
| » additionalProperties | string | false | none | none |
| display_names | CollectionDisplayNames | false | none | none |
| organisations | CollectionOrganisations | false | none | none |
| atom_feed | Feed | false | none | none |
| open_search | OpenSearch | false | none | none |
| inspire | Inspire | false | none | none |
| dublin_core_element_name | DublinCoreElementName | false | none | none |
| raster_tile_url | RasterTileURL | false | none | none |
| raster_tile_width | integer(int32) | false | none | none |
| raster_tile_height | integer(int32) | false | none | none |
| filter | Filter | false | none | none |
| license_name | string | false | none | none |
| license_urls | [string] | false | none | none |
DublinCoreElementName
{
"title": "string",
"creator": "string",
"subject": "string",
"description": "string",
"publisher": "string",
"contributor": "string",
"type": "string",
"format": "string",
"identifier": "string",
"source": "string",
"language": "string",
"bbox": {
"north": 0.1,
"south": 0.1,
"east": 0.1,
"west": 0.1
},
"date": "string",
"coverage": {},
"coverage_centroid": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| title | string | false | none | none |
| creator | string | false | none | none |
| subject | string | false | none | none |
| description | string | false | none | none |
| publisher | string | false | none | none |
| contributor | string | false | none | none |
| type | string | false | none | none |
| format | string | false | none | none |
| identifier | string | false | none | none |
| source | string | false | none | none |
| language | string | false | none | none |
| bbox | Bbox | false | none | none |
| date | string | false | none | none |
| coverage | object | false | none | none |
| coverage_centroid | string | false | none | none |
Expression
{
"field": "string",
"op": "eq",
"value": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| field | string | false | none | none |
| op | string | false | none | none |
| value | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| op | eq |
| op | gte |
| op | gt |
| op | lte |
| op | lt |
| op | like |
| op | ne |
| op | range |
| op | within |
| op | notwithin |
| op | intersects |
| op | notintersects |
Feed
{
"author": {
"name": "string",
"email": "string",
"uri": "string"
},
"contributor": {
"name": "string",
"email": "string",
"uri": "string"
},
"icon": "string",
"logo": "string",
"rights": "string",
"subtitle": "string",
"generator": {
"name": "string",
"version": "string",
"uri": "string"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| author | Person | false | none | none |
| contributor | Person | false | none | none |
| icon | string | false | none | none |
| logo | string | false | none | none |
| rights | string | false | none | none |
| subtitle | string | false | none | none |
| generator | Generator | false | none | none |
Filter
{
"f": [
[
{
"field": "string",
"op": "eq",
"value": "string"
}
]
],
"q": [
[
"string"
]
],
"dateformat": "string",
"righthand": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| f | [array] | false | none | none |
| » empty | boolean | false | none | none |
| q | [array] | false | none | none |
| » empty | boolean | false | none | none |
| dateformat | string | false | none | none |
| righthand | boolean | false | none | none |
Generator
{
"name": "string",
"version": "string",
"uri": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string | false | none | none |
| version | string | false | none | none |
| uri | string | false | none | none |
Inspire
{
"keywords": [
{
"value": "string",
"vocabulary": "string",
"date_of_publication": "string"
}
],
"topic_categories": [
"string"
],
"lineage": "string",
"languages": [
"string"
],
"spatial_resolution": {
"value": 0,
"unit_of_measure": "string"
},
"inspire_uri": {
"code": "string",
"namespace": "string"
},
"inspire_limitation_access": {
"access_constraints": "string",
"other_constraints": "string",
"classification": "string"
},
"inspire_use_conditions": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| keywords | [Keyword] | false | none | none |
| topic_categories | [string] | false | none | none |
| lineage | string | false | none | none |
| languages | [string] | false | none | none |
| spatial_resolution | InspireSpatialResolution | false | none | none |
| inspire_uri | InspireURI | false | none | none |
| inspire_limitation_access | InspireLimitationAccess | false | none | none |
| inspire_use_conditions | string | false | none | none |
InspireLimitationAccess
{
"access_constraints": "string",
"other_constraints": "string",
"classification": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| access_constraints | string | false | none | none |
| other_constraints | string | false | none | none |
| classification | string | false | none | none |
InspireSpatialResolution
{
"value": 0,
"unit_of_measure": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| value | number | false | none | none |
| unit_of_measure | string | false | none | none |
InspireURI
{
"code": "string",
"namespace": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| code | string | false | none | none |
| namespace | string | false | none | none |
JSONObject
{}
Properties
None
Keyword
{
"value": "string",
"vocabulary": "string",
"date_of_publication": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| value | string | false | none | none |
| vocabulary | string | false | none | none |
| date_of_publication | string | false | none | none |
MultiValueFilterExpression
[
{
"field": "string",
"op": "eq",
"value": "string"
}
]
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [Expression] | false | none | none |
| empty | boolean | false | none | none |
MultiValueFilterString
[
"string"
]
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| empty | boolean | false | none | none |
OpenSearch
{
"short_name": "string",
"description": "string",
"contact": "string",
"tags": "string",
"long_name": "string",
"image_height": "string",
"image_width": "string",
"image_type": "string",
"image_url": "string",
"developer": "string",
"attribution": "string",
"syndication_right": "string",
"adult_content": "string",
"language": "string",
"input_encoding": "string",
"output_encoding": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| short_name | string | false | none | none |
| description | string | false | none | none |
| contact | string | false | none | none |
| tags | string | false | none | none |
| long_name | string | false | none | none |
| image_height | string | false | none | none |
| image_width | string | false | none | none |
| image_type | string | false | none | none |
| image_url | string | false | none | none |
| developer | string | false | none | none |
| attribution | string | false | none | none |
| syndication_right | string | false | none | none |
| adult_content | string | false | none | none |
| language | string | false | none | none |
| input_encoding | string | false | none | none |
| output_encoding | string | false | none | none |
Person
{
"name": "string",
"email": "string",
"uri": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string | false | none | none |
| string | false | none | none | |
| uri | string | false | none | none |
RasterTileURL
{
"url": "string",
"id_path": "string",
"min_z": 0,
"max_z": 0,
"check_geometry": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| url | string | true | none | none |
| id_path | string | true | none | none |
| min_z | integer(int32) | false | none | none |
| max_z | integer(int32) | false | none | none |
| check_geometry | boolean | false | none | none |
FormDataContentDisposition
{
"type": "string",
"parameters": {
"property1": "string",
"property2": "string"
},
"fileName": "string",
"creationDate": "2019-08-24T14:15:22Z",
"modificationDate": "2019-08-24T14:15:22Z",
"readDate": "2019-08-24T14:15:22Z",
"size": 0,
"name": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | string | false | none | none |
| parameters | object | false | none | none |
| » additionalProperties | string | false | none | none |
| fileName | string | false | none | none |
| creationDate | string(date-time) | false | none | none |
| modificationDate | string(date-time) | false | none | none |
| readDate | string(date-time) | false | none | none |
| size | integer(int64) | false | none | none |
| name | string | false | none | none |
CollectionReferenceUpdateOrg
{
"public": true,
"shared": [
"string"
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| public | boolean | false | none | none |
| shared | [string] | false | none | none |
AggregationMetric
{
"type": "string",
"field": "string",
"value": {}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | string | false | none | none |
| field | string | false | none | none |
| value | object | false | none | none |
AggregationResponse
{
"query_time": 0,
"total_time": 0,
"totalnb": 0,
"name": "string",
"count": 0,
"sumotherdoccounts": 0,
"key": {},
"key_as_string": {},
"elements": [
{
"query_time": 0,
"total_time": 0,
"totalnb": 0,
"name": "string",
"count": 0,
"sumotherdoccounts": 0,
"key": {},
"key_as_string": {},
"elements": [],
"metrics": [
{
"type": "string",
"field": "string",
"value": {}
}
],
"hits": [
{}
],
"geometries": [
{
"reference": "string",
"geometry": {
"crs": {
"type": "name",
"properties": {
"property1": {},
"property2": {}
}
},
"bbox": [
0.1
],
"type": "string"
},
"sort": "string",
"is_raw": true
}
],
"flattened_elements": {
"property1": {},
"property2": {}
}
}
],
"metrics": [
{
"type": "string",
"field": "string",
"value": {}
}
],
"hits": [
{}
],
"geometries": [
{
"reference": "string",
"geometry": {
"crs": {
"type": "name",
"properties": {
"property1": {},
"property2": {}
}
},
"bbox": [
0.1
],
"type": "string"
},
"sort": "string",
"is_raw": true
}
],
"flattened_elements": {
"property1": {},
"property2": {}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| query_time | integer(int64) | false | none | none |
| total_time | integer(int64) | false | none | none |
| totalnb | integer(int64) | false | none | none |
| name | string | false | none | none |
| count | integer(int64) | false | none | none |
| sumotherdoccounts | integer(int64) | false | none | none |
| key | object | false | none | none |
| key_as_string | object | false | none | none |
| elements | [AggregationResponse] | false | none | none |
| metrics | [AggregationMetric] | false | none | none |
| hits | [object] | false | none | none |
| geometries | [ReturnedGeometry] | false | none | none |
| flattened_elements | object | false | none | none |
| » additionalProperties | object | false | none | none |
Crs
{
"type": "name",
"properties": {
"property1": {},
"property2": {}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | string | false | none | none |
| properties | object | false | none | none |
| » additionalProperties | object | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| type | name |
| type | link |
Feature
{
"crs": {
"type": "name",
"properties": {
"property1": {},
"property2": {}
}
},
"bbox": [
0.1
],
"type": "string",
"properties": {
"property1": {},
"property2": {}
},
"geometry": {
"crs": {
"type": "name",
"properties": {
"property1": {},
"property2": {}
}
},
"bbox": [
0.1
],
"type": "string"
},
"id": "string"
}
Properties
allOf - discriminator: GeoJsonObject.type
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | GeoJsonObject | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » properties | object | false | none | none |
| »» additionalProperties | object | false | none | none |
| » geometry | GeoJsonObject | false | none | none |
| » id | string | false | none | none |
FeatureCollection
{
"crs": {
"type": "name",
"properties": {
"property1": {},
"property2": {}
}
},
"bbox": [
0.1
],
"type": "string",
"features": [
{
"crs": {
"type": "name",
"properties": {
"property1": {},
"property2": {}
}
},
"bbox": [
0.1
],
"type": "string",
"properties": {
"property1": {},
"property2": {}
},
"geometry": {
"crs": {
"type": "name",
"properties": {
"property1": {},
"property2": {}
}
},
"bbox": [
0.1
],
"type": "string"
},
"id": "string"
}
]
}
Properties
allOf - discriminator: GeoJsonObject.type
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | GeoJsonObject | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » features | [Feature] | false | none | none |
GeoJsonObject
{
"crs": {
"type": "name",
"properties": {
"property1": {},
"property2": {}
}
},
"bbox": [
0.1
],
"type": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| crs | Crs | false | none | none |
| bbox | [number] | false | none | none |
| type | string | true | none | none |
GeometryCollection
{
"crs": {
"type": "name",
"properties": {
"property1": {},
"property2": {}
}
},
"bbox": [
0.1
],
"type": "string",
"geometries": [
{
"crs": {
"type": "name",
"properties": {
"property1": {},
"property2": {}
}
},
"bbox": [
0.1
],
"type": "string"
}
]
}
Properties
allOf - discriminator: GeoJsonObject.type
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | GeoJsonObject | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » geometries | [GeoJsonObject] | false | none | none |
LineString
{
"crs": {
"type": "name",
"properties": {
"property1": {},
"property2": {}
}
},
"bbox": [
0.1
],
"type": "string",
"coordinates": [
{
"longitude": 0.1,
"latitude": 0.1,
"altitude": 0.1,
"additionalElements": [
0.1
]
}
]
}
Properties
allOf - discriminator: GeoJsonObject.type
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | GeoJsonObject | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » coordinates | [LngLatAlt] | false | none | none |
LngLatAlt
{
"longitude": 0.1,
"latitude": 0.1,
"altitude": 0.1,
"additionalElements": [
0.1
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| longitude | number(double) | false | none | none |
| latitude | number(double) | false | none | none |
| altitude | number(double) | false | none | none |
| additionalElements | [number] | false | none | none |
MultiLineString
{
"crs": {
"type": "name",
"properties": {
"property1": {},
"property2": {}
}
},
"bbox": [
0.1
],
"type": "string",
"coordinates": [
[
{
"longitude": 0.1,
"latitude": 0.1,
"altitude": 0.1,
"additionalElements": [
0.1
]
}
]
]
}
Properties
allOf - discriminator: GeoJsonObject.type
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | GeoJsonObject | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » coordinates | [array] | false | none | none |
MultiPoint
{
"crs": {
"type": "name",
"properties": {
"property1": {},
"property2": {}
}
},
"bbox": [
0.1
],
"type": "string",
"coordinates": [
{
"longitude": 0.1,
"latitude": 0.1,
"altitude": 0.1,
"additionalElements": [
0.1
]
}
]
}
Properties
allOf - discriminator: GeoJsonObject.type
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | GeoJsonObject | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » coordinates | [LngLatAlt] | false | none | none |
MultiPolygon
{
"crs": {
"type": "name",
"properties": {
"property1": {},
"property2": {}
}
},
"bbox": [
0.1
],
"type": "string",
"coordinates": [
[
[
{
"longitude": 0.1,
"latitude": 0.1,
"altitude": 0.1,
"additionalElements": [
0.1
]
}
]
]
]
}
Properties
allOf - discriminator: GeoJsonObject.type
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | GeoJsonObject | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » coordinates | [array] | false | none | none |
Point
{
"crs": {
"type": "name",
"properties": {
"property1": {},
"property2": {}
}
},
"bbox": [
0.1
],
"type": "string",
"coordinates": {
"longitude": 0.1,
"latitude": 0.1,
"altitude": 0.1,
"additionalElements": [
0.1
]
}
}
Properties
allOf - discriminator: GeoJsonObject.type
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | GeoJsonObject | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » coordinates | LngLatAlt | false | none | none |
Polygon
{
"crs": {
"type": "name",
"properties": {
"property1": {},
"property2": {}
}
},
"bbox": [
0.1
],
"type": "string",
"coordinates": [
[
{
"longitude": 0.1,
"latitude": 0.1,
"altitude": 0.1,
"additionalElements": [
0.1
]
}
]
]
}
Properties
allOf - discriminator: GeoJsonObject.type
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | GeoJsonObject | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » coordinates | [array] | false | none | none |
ReturnedGeometry
{
"reference": "string",
"geometry": {
"crs": {
"type": "name",
"properties": {
"property1": {},
"property2": {}
}
},
"bbox": [
0.1
],
"type": "string"
},
"sort": "string",
"is_raw": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| reference | string | false | none | none |
| geometry | GeoJsonObject | false | none | none |
| sort | string | false | none | none |
| is_raw | boolean | false | none | none |
Aggregation
{
"type": "datehistogram",
"field": "string",
"interval": {
"value": 0,
"unit": "year"
},
"format": "string",
"metrics": [
{
"collect_field": "string",
"collect_fct": "AVG"
}
],
"order": "asc",
"on": "field",
"size": "string",
"include": "string",
"raw_geometries": [
{
"geometry": "string",
"sort": "string",
"signedSort": "string",
"include": [
"string"
]
}
],
"aggregated_geometries": [
"BBOX"
],
"fetch_hits": {
"size": 0,
"include": [
"string"
]
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | string | false | none | none |
| field | string | false | none | none |
| interval | Interval | false | none | none |
| format | string | false | none | none |
| metrics | [Metric] | false | none | none |
| order | string | false | none | none |
| on | string | false | none | none |
| size | string | false | none | none |
| include | string | false | none | none |
| raw_geometries | [RawGeometry] | false | none | none |
| aggregated_geometries | [string] | false | none | none |
| fetch_hits | HitsFetcher | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| type | datehistogram |
| type | geohash |
| type | geotile |
| type | histogram |
| type | term |
| type | geohex |
| order | asc |
| order | desc |
| on | field |
| on | count |
| on | result |
AggregationsRequest
{
"partitionFilter": [
{
"f": [
[
{
"field": "string",
"op": "eq",
"value": "string"
}
]
],
"q": [
[
"string"
]
],
"dateformat": "string",
"righthand": true
}
],
"filter": {
"f": [
[
{
"field": "string",
"op": "eq",
"value": "string"
}
]
],
"q": [
[
"string"
]
],
"dateformat": "string",
"righthand": true
},
"form": {
"pretty": true,
"flat": true
},
"aggregations": [
{
"type": "datehistogram",
"field": "string",
"interval": {
"value": 0,
"unit": "year"
},
"format": "string",
"metrics": [
{
"collect_field": "string",
"collect_fct": "AVG"
}
],
"order": "asc",
"on": "field",
"size": "string",
"include": "string",
"raw_geometries": [
{
"geometry": "string",
"sort": "string",
"signedSort": "string",
"include": [
"string"
]
}
],
"aggregated_geometries": [
"BBOX"
],
"fetch_hits": {
"size": 0,
"include": [
"string"
]
}
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| partitionFilter | [Filter] | false | none | none |
| filter | Filter | false | none | none |
| form | Form | false | none | none |
| aggregations | [Aggregation] | false | none | none |
Form
{
"pretty": true,
"flat": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| pretty | boolean | false | none | none |
| flat | boolean | false | none | none |
HitsFetcher
{
"size": 0,
"include": [
"string"
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| size | integer(int32) | false | none | none |
| include | [string] | false | none | none |
Interval
{
"value": 0,
"unit": "year"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| value | number | false | none | none |
| unit | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| unit | year |
| unit | quarter |
| unit | month |
| unit | week |
| unit | day |
| unit | hour |
| unit | minute |
| unit | second |
Metric
{
"collect_field": "string",
"collect_fct": "AVG"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| collect_field | string | false | none | none |
| collect_fct | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| collect_fct | AVG |
| collect_fct | CARDINALITY |
| collect_fct | MAX |
| collect_fct | MIN |
| collect_fct | SUM |
| collect_fct | GEOCENTROID |
| collect_fct | GEOBBOX |
RawGeometry
{
"geometry": "string",
"sort": "string",
"signedSort": "string",
"include": [
"string"
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| geometry | string | false | none | none |
| sort | string | false | none | none |
| signedSort | string | false | none | none |
| include | [string] | false | none | none |
ComputationResponse
{
"query_time": 0,
"total_time": 0,
"totalnb": 0,
"field": "string",
"metric": "AVG",
"value": 0.1,
"geometry": {
"crs": {
"type": "name",
"properties": {
"property1": {},
"property2": {}
}
},
"bbox": [
0.1
],
"type": "string"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| query_time | integer(int64) | false | none | none |
| total_time | integer(int64) | false | none | none |
| totalnb | integer(int64) | false | none | none |
| field | string | false | none | none |
| metric | string | false | none | none |
| value | number(double) | false | none | none |
| geometry | GeoJsonObject | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| metric | AVG |
| metric | MAX |
| metric | MIN |
| metric | SUM |
| metric | CARDINALITY |
| metric | SPANNING |
| metric | GEOBBOX |
| metric | GEOCENTROID |
ComputationRequest
{
"partitionFilter": [
{
"f": [
[
{
"field": "string",
"op": "eq",
"value": "string"
}
]
],
"q": [
[
"string"
]
],
"dateformat": "string",
"righthand": true
}
],
"filter": {
"f": [
[
{
"field": "string",
"op": "eq",
"value": "string"
}
]
],
"q": [
[
"string"
]
],
"dateformat": "string",
"righthand": true
},
"form": {
"pretty": true,
"flat": true
},
"field": "string",
"metric": "AVG"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| partitionFilter | [Filter] | false | none | none |
| filter | Filter | false | none | none |
| form | Form | false | none | none |
| field | string | false | none | none |
| metric | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| metric | AVG |
| metric | MAX |
| metric | MIN |
| metric | SUM |
| metric | CARDINALITY |
| metric | SPANNING |
| metric | GEOBBOX |
| metric | GEOCENTROID |
ArlasHit
{
"md": {
"id": "string",
"timestamp": 0,
"geometry": {
"crs": {
"type": "name",
"properties": {
"property1": {},
"property2": {}
}
},
"bbox": [
0.1
],
"type": "string"
},
"centroid": {
"crs": {
"type": "name",
"properties": {
"property1": {},
"property2": {}
}
},
"bbox": [
0.1
],
"type": "string"
},
"returned_geometries": [
{
"path": "string",
"geometry": {
"crs": {
"type": "name",
"properties": {
"property1": {},
"property2": {}
}
},
"bbox": [
0.1
],
"type": "string"
}
}
]
},
"data": {}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| md | MD | false | none | none |
| data | object | false | none | none |
Geo
{
"path": "string",
"geometry": {
"crs": {
"type": "name",
"properties": {
"property1": {},
"property2": {}
}
},
"bbox": [
0.1
],
"type": "string"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| path | string | false | none | none |
| geometry | GeoJsonObject | false | none | none |
Hits
{
"collection": "string",
"hits": [
{
"md": {
"id": "string",
"timestamp": 0,
"geometry": {
"crs": {
"type": "name",
"properties": {
"property1": {},
"property2": {}
}
},
"bbox": [
0.1
],
"type": "string"
},
"centroid": {
"crs": {
"type": "name",
"properties": {
"property1": {},
"property2": {}
}
},
"bbox": [
0.1
],
"type": "string"
},
"returned_geometries": [
{
"path": "string",
"geometry": {
"crs": {
"type": "name",
"properties": {
"property1": {},
"property2": {}
}
},
"bbox": [
0.1
],
"type": "string"
}
}
]
},
"data": {}
}
],
"nbhits": 0,
"totalnb": 0,
"links": {
"property1": {
"href": "string",
"method": "string",
"body": {}
},
"property2": {
"href": "string",
"method": "string",
"body": {}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| collection | string | false | none | none |
| hits | [ArlasHit] | false | none | none |
| nbhits | integer(int64) | false | none | none |
| totalnb | integer(int64) | false | none | none |
| links | object | false | none | none |
| » additionalProperties | Link | false | none | none |
Link
{
"href": "string",
"method": "string",
"body": {}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| href | string | true | none | none |
| method | string | true | none | none |
| body | object | false | none | none |
MD
{
"id": "string",
"timestamp": 0,
"geometry": {
"crs": {
"type": "name",
"properties": {
"property1": {},
"property2": {}
}
},
"bbox": [
0.1
],
"type": "string"
},
"centroid": {
"crs": {
"type": "name",
"properties": {
"property1": {},
"property2": {}
}
},
"bbox": [
0.1
],
"type": "string"
},
"returned_geometries": [
{
"path": "string",
"geometry": {
"crs": {
"type": "name",
"properties": {
"property1": {},
"property2": {}
}
},
"bbox": [
0.1
],
"type": "string"
}
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | false | none | none |
| timestamp | integer(int64) | false | none | none |
| geometry | GeoJsonObject | false | none | none |
| centroid | GeoJsonObject | false | none | none |
| returned_geometries | [Geo] | false | none | none |
Count
{
"partitionFilter": [
{
"f": [
[
{
"field": "string",
"op": "eq",
"value": "string"
}
]
],
"q": [
[
"string"
]
],
"dateformat": "string",
"righthand": true
}
],
"filter": {
"f": [
[
{
"field": "string",
"op": "eq",
"value": "string"
}
]
],
"q": [
[
"string"
]
],
"dateformat": "string",
"righthand": true
},
"form": {
"pretty": true,
"flat": true
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| partitionFilter | [Filter] | false | none | none |
| filter | Filter | false | none | none |
| form | Form | false | none | none |
CollectionReferenceDescription
{
"properties": {
"property1": {
"type": "TEXT",
"format": "string",
"hash_field": "string",
"properties": {
"property1": {},
"property2": {}
},
"taggable": true,
"indexed": true
},
"property2": {
"type": "TEXT",
"format": "string",
"hash_field": "string",
"properties": {
"property1": {},
"property2": {}
},
"taggable": true,
"indexed": true
}
},
"collection_name": "string",
"params": {
"index_name": "string",
"id_path": "string",
"geometry_path": "string",
"centroid_path": "string",
"timestamp_path": "string",
"exclude_fields": "string",
"update_max_hits": 0,
"taggable_fields": "string",
"exclude_wfs_fields": "string",
"custom_params": {
"property1": "string",
"property2": "string"
},
"display_names": {
"collection": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"shape_columns": {
"property1": "string",
"property2": "string"
}
},
"organisations": {
"owner": "string",
"shared": [
"string"
],
"public": true
},
"atom_feed": {
"author": {
"name": "string",
"email": "string",
"uri": "string"
},
"contributor": {
"name": "string",
"email": "string",
"uri": "string"
},
"icon": "string",
"logo": "string",
"rights": "string",
"subtitle": "string",
"generator": {
"name": "string",
"version": "string",
"uri": "string"
}
},
"open_search": {
"short_name": "string",
"description": "string",
"contact": "string",
"tags": "string",
"long_name": "string",
"image_height": "string",
"image_width": "string",
"image_type": "string",
"image_url": "string",
"developer": "string",
"attribution": "string",
"syndication_right": "string",
"adult_content": "string",
"language": "string",
"input_encoding": "string",
"output_encoding": "string"
},
"inspire": {
"keywords": [
{
"value": "string",
"vocabulary": "string",
"date_of_publication": "string"
}
],
"topic_categories": [
"string"
],
"lineage": "string",
"languages": [
"string"
],
"spatial_resolution": {
"value": 0,
"unit_of_measure": "string"
},
"inspire_uri": {
"code": "string",
"namespace": "string"
},
"inspire_limitation_access": {
"access_constraints": "string",
"other_constraints": "string",
"classification": "string"
},
"inspire_use_conditions": "string"
},
"dublin_core_element_name": {
"title": "string",
"creator": "string",
"subject": "string",
"description": "string",
"publisher": "string",
"contributor": "string",
"type": "string",
"format": "string",
"identifier": "string",
"source": "string",
"language": "string",
"bbox": {
"north": 0.1,
"south": 0.1,
"east": 0.1,
"west": 0.1
},
"date": "string",
"coverage": {},
"coverage_centroid": "string"
},
"raster_tile_url": {
"url": "string",
"id_path": "string",
"min_z": 0,
"max_z": 0,
"check_geometry": true
},
"raster_tile_width": 0,
"raster_tile_height": 0,
"filter": {
"f": [
[
{
"field": "string",
"op": "eq",
"value": "string"
}
]
],
"q": [
[
"string"
]
],
"dateformat": "string",
"righthand": true
},
"license_name": "string",
"license_urls": [
"string"
]
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| properties | object | false | none | none |
| » additionalProperties | CollectionReferenceDescriptionProperty | false | none | none |
| collection_name | string | true | none | none |
| params | CollectionReferenceParameters | true | none | none |
CollectionReferenceDescriptionProperty
{
"type": "TEXT",
"format": "string",
"hash_field": "string",
"properties": {
"property1": {
"type": "TEXT",
"format": "string",
"hash_field": "string",
"properties": {},
"taggable": true,
"indexed": true
},
"property2": {
"type": "TEXT",
"format": "string",
"hash_field": "string",
"properties": {},
"taggable": true,
"indexed": true
}
},
"taggable": true,
"indexed": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | string | false | none | none |
| format | string | false | none | none |
| hash_field | string | false | none | none |
| properties | object | false | none | none |
| » additionalProperties | CollectionReferenceDescriptionProperty | false | none | none |
| taggable | boolean | false | none | none |
| indexed | boolean | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| type | TEXT |
| type | KEYWORD |
| type | LONG |
| type | INTEGER |
| type | SHORT |
| type | BYTE |
| type | DOUBLE |
| type | FLOAT |
| type | DATE |
| type | BOOLEAN |
| type | BINARY |
| type | INT_RANGE |
| type | FLOAT_RANGE |
| type | LONG_RANGE |
| type | DOUBLE_RANGE |
| type | DATE_RANGE |
| type | OBJECT |
| type | NESTED |
| type | GEO_POINT |
| type | GEO_SHAPE |
| type | IP |
| type | COMPLETION |
| type | TOKEN_COUNT |
| type | MAPPER_MURMUR3 |
| type | UNKNOWN |
| type | VARCHAR |
| type | CHAR |
| type | CHARACTER |
| type | BIT |
| type | TINYINT |
| type | SMALLINT |
| type | INT |
| type | BIGINT |
| type | DECIMAL |
| type | NUMERIC |
| type | REAL |
| type | DOUBLEPRECISION |
| type | TIMESTAMP |
| type | TIME |
| type | INTERVAL |
| type | GEOMETRY |
| type | GEOGRAPHY |
| type | POINT |
| type | LINESTRING |
| type | POLYGON |
| type | MULTIPOINT |
| type | MULTILINESTRING |
| type | MULTIPOLYGON |
| type | GEOMETRYCOLLECTION |
| type | MURMUR3 |
Page
{
"size": 0,
"from": 0,
"sort": "string",
"after": "string",
"before": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| size | integer(int32) | false | none | none |
| from | integer(int32) | false | none | none |
| sort | string | false | none | none |
| after | string | false | none | none |
| before | string | false | none | none |
Projection
{
"includes": "string",
"excludes": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| includes | string | false | none | none |
| excludes | string | false | none | none |
Search
{
"partitionFilter": [
{
"f": [
[
{
"field": "string",
"op": "eq",
"value": "string"
}
]
],
"q": [
[
"string"
]
],
"dateformat": "string",
"righthand": true
}
],
"filter": {
"f": [
[
{
"field": "string",
"op": "eq",
"value": "string"
}
]
],
"q": [
[
"string"
]
],
"dateformat": "string",
"righthand": true
},
"form": {
"pretty": true,
"flat": true
},
"page": {
"size": 0,
"from": 0,
"sort": "string",
"after": "string",
"before": "string"
},
"projection": {
"includes": "string",
"excludes": "string"
},
"returned_geometries": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| partitionFilter | [Filter] | false | none | none |
| filter | Filter | false | none | none |
| form | Form | false | none | none |
| page | Page | false | none | none |
| projection | Projection | false | none | none |
| returned_geometries | string | false | none | none |