Cookies help us provide, improve, and protect this website. By using our services, you agree to our cookie policy

API Documentation

sobloo provides high performing and easy to use APIs to manipulate all its data in a convenient and efficient way.

If you want to get started immediately take a look at our "tutorial page".

Datastore API

Overview

Sobloo offer several endpoints:

You can get Quicklooks and thumbnails of a product using those endpoints:

Finally, OGC endpoints are available too:

Version information

Version : 0.1.0

URI scheme

BasePath : /api/v1/services
Schemes : HTTP, HTTPS

Tags

  • explore

Paths

OGC Catalog Services (Web)

GET /csw

Description

Give access to OGC CSW exploration services. This endpoint uses standard OGC CSW communication.

Responses

HTTP Code Description Schema

200

Service found

No Content

500

Application Server Error

No Content

Produces

  • application/xml

Tags

  • explore

Download product

GET /download/{productId}

Parameters

Type Name Description Schema

Path

productId
required

Product ID

string (uuid)

Responses

HTTP Code Description Schema

200

Product found

No Content

404

Product not found

No Content

500

Application Server Error

No Content

Produces

  • application/zip

Tags

  • explore

OpenSearch Description Document

GET /opensearch

Description

Access to the OpenSearch Description document for the given collection

Parameters

Type Name Description Schema

Path

collection
required

collection

string

Query

max-age-cache
optional

max-age-cache

integer (int32)

Responses

HTTP Code Description Schema

200

Successful operation

No Content

400

Bad request.

Error

500

Arlas Server Error.

Error

Produces

  • application/xml

Tags

  • explore

Get quicklook image for the given product

GET /quicklook/{productId}

Parameters

Type Name Description Schema

Path

productId
required

Product ID

string (uuid)

Responses

HTTP Code Description Schema

200

Quicklook found

No Content

404

Quicklook not found

No Content

500

Application Server Error

No Content

Produces

  • image/jpeg

Tags

  • explore

GET /search

Description

Search and return the elements found in the collection, given the filters

Parameters

Type Name Description Schema Default

Path

collection
required

collection

string

 

Query

exclude
optional

List the name patterns of the field to be excluded in the result. Seperate patterns with a comma.

< string > array(multi)

 

Query

f
optional

* 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 ----

< string > array(multi)

 

Query

from
optional

From index to start the search from. Defaults to 0.

integer

0

Query

gintersect
optional

Any element having its geometry intersecting the given geometry (WKT)

< string > array(multi)

 

Query

gwithin
optional

Any element having its geometry contained within the given geometry (WKT)

< string > array(multi)

 

Query

include
optional

List the name patterns of the field to be included in the result. Seperate patterns with a comma.

< string > array(multi)

 

Query

max-age-cache
optional

max-age-cache

integer (int32)

 

Query

notgintersect
optional

Any element having its geometry not intersecting the given geometry (WKT)

< string > array(multi)

 

Query

notgwithin
optional

Any element having its geometry outside the given geometry (WKT)

< string > array(multi)

 

Query

notpwithin
optional

Any element having its centroid outside the given bbox : 'top, left, bottom, right'.

< string > array(multi)

 

Query

pretty
optional

Pretty print

boolean

"false"

Query

pwithin
optional

Any element having its centroid contained within the given bbox : 'top, left, bottom, right'.

< string > array(multi)

 

Query

q
optional

A full text search. Optionally, it’s possible to search on a field using this syntax: {fieldname}:{text}

< string > array(multi)

 

Query

size
optional

The maximum number of entries or sub-entries to be returned. The default value is 10

integer

10

Query

sort
optional

* Sort the result on the given fields ascending or descending.

* Fields can be provided several times by separating them with a comma. The order matters.

* For a descending sort, precede the field with '-'. The sort will be ascending otherwise.

* For a geodistance sort, specify the point, from which the distances are calculated, as follow : 'geodistance:lat lon'

string

 

Responses

HTTP Code Description Schema

200

Successful operation

Hits

400

Bad request.

Error

500

Arlas Server Error.

Error

Consumes

  • application/json;charset=utf-8

Produces

  • application/json;charset=utf-8

  • application/atom+xml

Tags

  • explore

Get thumbnail image for the given product

GET /thumbnail/{productId}

Parameters

Type Name Description Schema

Path

productId
required

Product ID

string (uuid)

Responses

HTTP Code Description Schema

200

Thumbnail found

No Content

404

Thumbnail not found

No Content

500

Application Server Error

No Content

Produces

  • image/jpeg

Tags

  • explore

OGC Web Coverage Service

GET /wcs/{productId}

Parameters

Type Name Description Schema

Path

productId
required

Product ID

string (uuid)

Responses

HTTP Code Description Schema

200

Product found

No Content

404

Product not found

No Content

500

Application Server Error

No Content

Produces

  • image/jpeg

Tags

  • explore

OGC Web Feature Service

GET /wfs

Description

Give access to OGC WFS exploration services. This endpoint uses standard OGC WFS communication.

Responses

HTTP Code Description Schema

200

Service found

No Content

500

Application Server Error

No Content

Produces

  • application/xml

Tags

  • explore

OGC Web Map Service

GET /wms/{productId}

Parameters

Type Name Description Schema

Path

productId
required

Product ID

string (uuid)

Responses

HTTP Code Description Schema

200

Product found

No Content

404

Product not found

No Content

500

Application Server Error

No Content

Produces

  • image/jpeg

Tags

  • explore

OGC Web Map Tile Service

GET /wmts/{productId}

Parameters

Type Name Description Schema

Path

productId
required

Product ID

string (uuid)

Responses

HTTP Code Description Schema

200

Product found

No Content

404

Product not found

No Content

500

Application Server Error

No Content

Produces

  • image/jpeg

Tags

  • explore

Definitions

Aggregation

Name Schema

collectFct
optional

enum (AVG, CARDINALITY, MAX, MIN, SUM, GEOCENTROID, GEOBBOX)

collectField
optional

string

field
optional

string

format
optional

string

include
optional

string

interval
optional

Interval

on
optional

enum (field, count, result)

order
optional

enum (asc, desc)

size
optional

string

type
optional

enum (datehistogram, geohash, histogram, term)

withGeoBBOX
optional

boolean

withGeoCentroid
optional

boolean

AggregationMetric

Name Schema

field
optional

string

type
optional

string

value
optional

object

AggregationResponse

Name Schema

bbox
optional

Polygon

centroid
optional

Point

count
optional

integer (int64)

elements
optional

< AggregationResponse > array

key
optional

object

key_as_string
optional

object

metric
optional

AggregationMetric

name
optional

string

query_time
optional

integer (int64)

sumotherdoccounts
optional

integer (int64)

total_time
optional

integer (int64)

totalnb
optional

integer (int64)

AggregationsRequest

Name Schema

aggregations
optional

< Aggregation > array

filter
optional

Filter

form
optional

Form

Bbox

Name Schema

east
required

number (double)

north
required

number (double)

south
required

number (double)

west
required

number (double)

Binary

Type : object

CollectionReference

Name Schema

collection_name
required

string

params
required

CollectionReferenceParameters

CollectionReferenceDescription

Name Schema

collection_name
required

string

params
required

CollectionReferenceParameters

properties
optional

< string, CollectionReferenceDescriptionProperty > map

CollectionReferenceDescriptionProperty

Name Schema

format
optional

string

properties
optional

< string, CollectionReferenceDescriptionProperty > map

taggable
optional

boolean

type
optional

enum (TEXT, KEYWORD, LONG, INTEGER, SHORT, BYTE, DOUBLE, FLOAT, DATE, BOOLEAN, BINARY, INT_RANGE, FLOAT_RANGE, LONG_RANGE, DOUBLE_RANGE, DATE_RANGE, OBJECT, NESTED, GEO_POINT, GEO_SHAPE, IP, COMPLETION, TOKEN_COUNT, MAPPER_MURMUR3, UNKNOWN)

CollectionReferenceParameters

Name Schema

atom_feed
optional

Feed

centroid_path
required

string

custom_params
optional

< string, string > map

dublin_core_element_name
optional

DublinCoreElementName

exclude_fields
optional

string

exclude_wfs_fields
optional

string

geometry_path
required

string

id_path
required

string

index_name
required

string

open_search
optional

OpenSearch

taggable_fields
optional

string

timestamp_path
required

string

type_name
required

string

update_max_hits
optional

integer (int32)

Count

Name Schema

filter
optional

Filter

form
optional

Form

Crs

Name Schema

properties
optional

< string, object > map

type
optional

enum (name, link)

DublinCoreElementName

Name Schema

bbox
optional

Bbox

contributor
optional

string

coverage
optional

< string, object > map

creator
optional

string

date
optional

string

description
optional

string

format
optional

string

identifier
optional

string

language
optional

string

publisher
optional

string

source
optional

string

subject
optional

string

title
optional

string

type
optional

string

Error

Name Schema

error
optional

string

message
optional

string

status
optional

integer (int32)

Expression

Name Schema

field
optional

string

op
optional

enum (eq, gte, gt, lte, lt, like, ne, range)

value
optional

string

Failure

Name Schema

id
optional

string

message
optional

string

type
optional

string

Feature

Polymorphism : Inheritance
Discriminator : type

Name Schema

bbox
optional

< number (double) > array

crs
optional

Crs

geometry
optional

GeoJsonObject

id
optional

string

properties
optional

< string, object > map

FeatureCollection

Polymorphism : Inheritance
Discriminator : type

Name Schema

bbox
optional

< number (double) > array

crs
optional

Crs

features
optional

< Feature > array

Feed

Name Schema

author
optional

Person

contributor
optional

Person

generator
optional

Generator

icon
optional

string

logo
optional

string

rights
optional

string

subtitle
optional

string

Filter

Name Schema

f
optional

< < Expression > array > array

gintersect
optional

< < string > array > array

gwithin
optional

< < string > array > array

notgintersect
optional

< < string > array > array

notgwithin
optional

< < string > array > array

notpwithin
optional

< < string > array > array

pwithin
optional

< < string > array > array

q
optional

< < string > array > array

Form

Name Schema

pretty
optional

boolean

Generator

Name Schema

name
optional

string

uri
optional

string

version
optional

string

GeoJsonObject

Name Schema

bbox
optional

< number (double) > array

crs
optional

Crs

GeometryCollection

Polymorphism : Inheritance
Discriminator : type

Name Schema

bbox
optional

< number (double) > array

crs
optional

Crs

geometries
optional

< GeoJsonObject > array

Hit

Name Schema

data
optional

object

md
optional

MD

Hits

Name Schema

collection
optional

string

hits
optional

< Hit > array

nbhits
optional

integer (int64)

totalnb
optional

integer (int64)

Interval

Name Schema

unit
optional

enum (year, quarter, month, week, day, hour, minute, second)

value
optional

integer (int32)

LineString

Polymorphism : Inheritance
Discriminator : type

Name Schema

bbox
optional

< number (double) > array

coordinates
optional

< LngLatAlt > array

crs
optional

Crs

LngLatAlt

Name Schema

additionalElements
optional

< number (double) > array

altitude
optional

number (double)

latitude
optional

number (double)

longitude
optional

number (double)

MD

Name Schema

centroid
optional

GeoJsonObject

geometry
optional

GeoJsonObject

id
optional

string

timestamp
optional

integer (int64)

MultiLineString

Polymorphism : Inheritance
Discriminator : type

Name Schema

bbox
optional

< number (double) > array

coordinates
optional

< < LngLatAlt > array > array

crs
optional

Crs

MultiPoint

Polymorphism : Inheritance
Discriminator : type

Name Schema

bbox
optional

< number (double) > array

coordinates
optional

< LngLatAlt > array

crs
optional

Crs

MultiPolygon

Polymorphism : Inheritance
Discriminator : type

Name Schema

bbox
optional

< number (double) > array

coordinates
optional

< < < LngLatAlt > array > array > array

crs
optional

Crs

OpenSearch

Name Schema

adult_content
optional

string

attribution
optional

string

contact
optional

string

description
optional

string

developer
optional

string

image_height
optional

string

image_type
optional

string

image_url
optional

string

image_width
optional

string

input_encoding
optional

string

language
optional

string

long_name
optional

string

output_encoding
optional

string

short_name
optional

string

syndication_right
optional

string

tags
optional

string

url_template_prefix
optional

string

Person

Name Schema

email
optional

string

name
optional

string

uri
optional

string

Point

Polymorphism : Inheritance
Discriminator : type

Name Schema

bbox
optional

< number (double) > array

coordinates
optional

LngLatAlt

crs
optional

Crs

Polygon

Polymorphism : Inheritance
Discriminator : type

Name Schema

bbox
optional

< number (double) > array

coordinates
optional

< < LngLatAlt > array > array

crs
optional

Crs

Projection

Name Schema

excludes
optional

string

includes
optional

string

Name Schema

filter
optional

Filter

form
optional

Form

projection
optional

Projection

size
optional

Size

sort
optional

Sort

Size

Name Schema

from
optional

integer (int32)

size
optional

integer (int32)

Sort

Name Schema

sort
optional

string

Success

Name Schema

message
optional

string

status
optional

integer (int32)

Tag

Name Schema

path
optional

string

value
optional

object

TagRequest

Name Schema

search
optional

Search

tag
optional

Tag

UpdateResponse

Name Schema

action
optional

enum (ADD, REMOVE, REMOVEALL)

failed
optional

integer (int64)

failures
optional

< Failure > array

updated
optional

integer (int64)