OpenSearch for EO search index access

Allows to manipulate the OpenSearch for EO index
More information: http://geoserver.org/comm/
Contact Info: geoserver-users@sourceforge.net
Version: 1.0.0
BasePath:/geoserver/rest/oseo/
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

Methods

[ Jump to Models ]

Table of Contents

Default

Default

Up
delete /collections/{collection}
(collectionsCollectionDelete)
Deletes a collection and everything inside it

Path parameters

collection (required)
Path Parameter — Identifier of the collection

Query parameters

keepMetadata (optional)
Query Parameter — When present and set to true, makes GeoServer un-publish the collection (removal of OGC links, removal of associated layer) without removing the metadata. The collection remains searchable.

Responses

200

OK

404

The specified collection cannot be found

Up
delete /collections/{collection}/description
(collectionsCollectionDescriptionDelete)
Removes the collection HTML description

Path parameters

collection (required)
Path Parameter — Identifier of the collection

Responses

200

OK

400

Returned if the target collection or layer is already there

404

The specified product cannot be found

Up
get /collections/{collection}/description
(collectionsCollectionDescriptionGet)
Returns the HTML description of this collection

Path parameters

collection (required)
Path Parameter — Identifier of the collection

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success

Example data

Content-Type: text/html
Title Sentinel-2
Description The SENTINEL-2 mission is a land monitoring constellation of two satellites each equipped with a MSI (Multispectral Imager) instrument covering 13 spectral bands providing high resolution optical imagery (i.e., 10m, 20m, 60 m) every 10 days with one satellite and 5 days with two satellites.
Type Collection
Date 2015-06-23T00:00:00Z/
Media Type ATOM
Metadata ISO

404

The specified collection cannot be found

Up
put /collections/{collection}/description
(collectionsCollectionDescriptionPut)
Updates/creates a collection HTML description

Path parameters

collection (required)
Path Parameter — Identifier of the collection

Consumes

This API call consumes the following media types via the Content-Type request header:

Responses

200

Success

404

The specified collection cannot be found

Up
get /collections/{collection}
(collectionsCollectionGet)
Retrieves a collection search attributes and its ogc links

Path parameters

collection (required)
Path Parameter — Identifier of the collection

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success. The response contains cross links to ogcLinks/metadata/description/thumnail sub-resources.

Example data

Content-Type: application/json
{
  "type": "Feature",
  "geometry": {
    "type":"Polygon",
    "coordinates":[[[-180,-90],[180,-90],[180,90],[-180,90],[-180, -90]]]
  },
  "properties": {
    "name": "SENTINEL2",
    "primary": true,
    "timeStart" : "2012-04-23T18:25:43.511Z",
    "timeEnd" : null,
    "productcqlfilter" : null,
    "masked" : false,
    "eo:identifier" : "SENTINEL2",
    "eo:productType" : "S2MS1C",
    "eo:platform" : "Sentinel-2",
    "eo:platformSerialIdentifier" : "A",
    "eo:instrument" : "MSI",
    "eo:sensorType" : "OPTICAL",
    "eo:compositeType" : null,
    "eo:processingLevel" : "Level-1C",
    "eo:orbitType" : "LEO",
    "eo:spectralRange" : null,
    "eo:wavelength" : null,
    "eo:securityConstraints" : null,
    "eo:dissemination" : null,
    "eo:acquisitionStation" : null,
    "ogcLinksHref": "http://host:port/geoserver/rest/oseo/collection/SENTINEL2/ogcLinks",
    "metadataHref": "http://host:port/geoserver/rest/oseo/collection/SENTINEL2/metadata",
    "descriptionHref": "http://host:port/geoserver/rest/oseo/collection/SENTINEL2/description",
    "thumbnailHref": "http://host:port/geoserver/rest/oseo/collection/SENTINEL2/thumbnail"
  }
}

404

The specified collection cannot be found

Up
delete /collections/{collection}/layer
(collectionsCollectionLayerDelete)
Removes the mosaic configuration, store, layer and style associated to this collection

Path parameters

collection (required)
Path Parameter — Identifier of the collection

Responses

200

OK

404

The specified collection or publishing configuration cannot be found

Up
get /collections/{collection}/layer
(collectionsCollectionLayerGet)
Returns the current publishing configuration for the layer (or 404 if no configuration is currently in use)

Path parameters

collection (required)
Path Parameter — Identifier of the collection

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success

Example data

Content-Type: application/json
{
  "workspace": "gs",
  "layer": "test123",
  "separateBands": true,
  "bands": [
        "B02",
        "B03",
        "B04",
        "B08"
    ],
    "browseBands": [
        "B08",
        "B03",
        "B02"
    ],
  "heterogeneousCRS": true,
  "mosaicCRS": "EPSG:4326",
  "defaultLayer": true
}        

404

The specified collection or publishing configuration cannot be found

Up
put /collections/{collection}/layer
(collectionsCollectionLayerPut)
Removes the previous publshing configuration and replaces with a new one, creating along the mosaic configuration, store, layer and style as described

Path parameters

collection (required)
Path Parameter — Identifier of the collection

Consumes

This API call consumes the following media types via the Content-Type request header:

Responses

200

Success

400

The payload does not match the expected structure

404

The specified collection cannot be found

Up
get /collections/{collection}/layers
(collectionsCollectionLayersGet)
Returns the list of collection layers

Path parameters

collection (required)
Path Parameter — Identifier of the collection

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success

Example data

Content-Type: application/json
{
  "workspace": "gs",
  "layer": "test123",
  "separateBands": true,
  "bands": [
        "B02",
        "B03",
        "B04",
        "B08"
    ],
    "browseBands": [
        "B08",
        "B03",
        "B02"
    ],
  "heterogeneousCRS": true,
  "mosaicCRS": "EPSG:4326"
}  

404

The specified collection cannot be found

Up
delete /collections/{collection}/layers/{layer}
(collectionsCollectionLayersLayerDelete)
Removes the collection layer configuration

Path parameters

collection (required)
Path Parameter — Identifier of the collection
layer (required)
Path Parameter — Identifier of the layer

Responses

200

OK

404

The specified collection or layer cannot be found

Up
get /collections/{collection}/layers/{layer}
(collectionsCollectionLayersLayerGet)
Returns the list of collection layers

Path parameters

collection (required)
Path Parameter — Identifier of the collection
layer (required)
Path Parameter — Identifier of the layer

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success

Example data

Content-Type: application/json
{
  "layers": [
    {
      "name": "test123-layer1",
      "href": "http://localhost:8080/geoserver/rest/oseo/collections/TEST123/layers/test123-layer1"
    },
    {
      "name": "test123-layer2",
      "href": "http://localhost:8080/geoserver/rest/oseo/collections/TEST123/layers/test123-layer2"
    }
  ]
}

404

The specified collection or layer cannot be found

Up
put /collections/{collection}/layers/{layer}
(collectionsCollectionLayersLayerPut)
Updates/creates a collection layer publishing configuration

Path parameters

collection (required)
Path Parameter — Identifier of the collection
layer (required)
Path Parameter — Identifier of the layer

Consumes

This API call consumes the following media types via the Content-Type request header:

Responses

200

Success

404

The specified collection cannot be found

Up
delete /collections/{collection}/metadata
(collectionsCollectionMetadataDelete)
Removes the product metadata

Path parameters

collection (required)
Path Parameter — Identifier of the collection

Responses

200

OK

404

The specified collection cannot be found

Up
get /collections/{collection}/metadata
(collectionsCollectionMetadataGet)
Returns the ISO metadata of this collection

Path parameters

collection (required)
Path Parameter — Identifier of the collection

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success

404

The specified collection cannot be found

Up
put /collections/{collection}/metadata
(collectionsCollectionMetadataPut)
Updates/creates a collection ISO metadata

Path parameters

collection (required)
Path Parameter — Identifier of the collection

Consumes

This API call consumes the following media types via the Content-Type request header:

Responses

200

Success

400

The metadata is not a match for the target schema

404

The specified collection cannot be found

Up
delete /collections/{collection}/ogcLinks
(collectionsCollectionOgcLinksDelete)
Removes the collection OGC links

Path parameters

collection (required)
Path Parameter — Identifier of the collection

Responses

200

OK

404

The specified product cannot be found

Up
get /collections/{collection}/ogcLinks
(collectionsCollectionOgcLinksGet)
Returns the list of OGC links

Path parameters

collection (required)
Path Parameter — Identifier of the collection

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success

Example data

Content-Type: application/json
{
  "links": [
     {
       "offering": "http://www.opengis.net/spec/owc/1.0/req/atom/wms",
       "method": "GET",
       "code": "GetCapabilities",
       "type": "application/xml",
       "href": "${BASE_URL}/sentinel1/ows?service=wms&version=1.3.0&request=GetCapabilities"
     },
     {
       "offering": "http://www.opengis.net/spec/owc/1.0/req/atom/wms",
       "method": "GET",
       "code": "GetMap",
       "type": "image/jpeg",
       "href": "${BASE_URL}/landsat8/LS8_RGB/wms?SERVICE=WMS&VERSION=1.1.1&REQUEST=GetMap&FORMAT=image%2Fjpeg&STYLES&LAYERS=landsat8%3ALS8_RGB&SRS=EPSG%3A4326&WIDTH=800&HEIGHT=600&BBOX=-180%2C-90%2C180%2C90"
     }
  ]
}

404

The specified collection cannot be found

Up
put /collections/{collection}/ogcLinks
(collectionsCollectionOgcLinksPut)
Updates/creates a collection OGC links

Path parameters

collection (required)
Path Parameter — Identifier of the collection

Consumes

This API call consumes the following media types via the Content-Type request header:

Responses

200

Success

400

The payload does not match the expected structure (

404

The specified collection cannot be found

Up
get /collections/{collection}/products
(collectionsCollectionProductsGet)
Returns a paged list of all available products

Path parameters

collection (required)
Path Parameter — Identifier of the collection

Query parameters

offset (optional)
Query Parameter — First element for paged responses default: 0
limit (optional)
Query Parameter — Number of elements in page default: 10

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success

Example data

Content-Type: application/json
{
  "products" : [
        {
          "id" : "S2A_OPER_MSI_L1C_TL_SGS__20160929T154211_A006640_T32TPP_N02.04",
          "href" : "http://host:port/geoserver/rest/oseo/collections/SENTINEL2/products/S2A_OPER_MSI_L1C_TL_SGS__20160929T154211_A006640_T32TPP_N02.04",
          "rss": "http://host:port/geoserver/oseo/search?uid=S2A_OPER_MSI_L1C_TL_SGS__20160929T154211_A006640_T32TPP_N02.04"
        },
        {
          "id" : "S2A_OPER_MSI_L1C_TL_SGS__20161207T162012_A007627_T31TCG_N02.04",
          "href" : "http://host:port/geoserver/rest/oseo/collections/SENTINEL2/products/S2A_OPER_MSI_L1C_TL_SGS__20161207T162012_A007627_T31TCG_N02.04",
          "rss": "http://host:port/geoserver/oseo/search?uid=S2A_OPER_MSI_L1C_TL_SGS__20161207T162012_A007627_T31TCG_N02.04"
        }
  ]
}

404

The specified collection cannot be found

Up
post /collections/{collection}/products
(collectionsCollectionProductsPost)

Creates a new product via its search attributes and ogc links. The zip format accepts a set of files creating the collection in a single shot, and will contain the following files:

Path parameters

collection (required)
Path Parameter — Identifier of the collection

Consumes

This API call consumes the following media types via the Content-Type request header:

Responses

201

Created

400

The payload provided does not match the expected structure (error message will provide details)

404

The specified collection cannot be found

409

Returned if the target collection or layer is already there

Up
delete /collections/{collection}/products/{product}
(collectionsCollectionProductsProductDelete)
Deletes a product and everything inside it

Path parameters

collection (required)
Path Parameter — Identifier of the collection
product (required)
Path Parameter — Identifier of the product

Query parameters

keepMetadata (optional)
Query Parameter — When present and set to true, makes GeoServer un-publish the product (removal of OGC links, direct download location and granule references) without removing the metadata. The product remains searchable.

Responses

200

OK

Up
delete /collections/{collection}/products/{product}/description
(collectionsCollectionProductsProductDescriptionDelete)
Removes the product HTML description

Path parameters

collection (required)
Path Parameter — Identifier of the collection
product (required)
Path Parameter — Identifier of the product

Responses

200

OK

404

The specified product cannot be found

Up
get /collections/{collection}/products/{product}/description
(collectionsCollectionProductsProductDescriptionGet)
Returns the HTML description of this product

Path parameters

collection (required)
Path Parameter — Identifier of the collection
product (required)
Path Parameter — Identifier of the product

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success

Example data

Content-Type: text/html
Date 2016-01-17T10:10:30.743Z / 2016-01-17T10:10:30.743Z
Media Type ATOM
Metadata O&M

404

The specified product cannot be found

Up
put /collections/{collection}/products/{product}/description
(collectionsCollectionProductsProductDescriptionPut)
Updates/creates a product HTML description

Path parameters

collection (required)
Path Parameter — Identifier of the collection
product (required)
Path Parameter — Identifier of the product

Consumes

This API call consumes the following media types via the Content-Type request header:

Responses

200

Success

404

The specified product cannot be found

Up
get /collections/{collection}/products/{product}
(collectionsCollectionProductsProductGet)
Retrieves a product search attributes, ogc links and granules. The response contains cross links to ogcLinks/metadata/description/thumnail/granules sub-resources, when the same JSON is used o create a new collection the associated can be omitted, or if everything needs to be put in the JSON, the associated representations can be inlined instead (the thumbnail image can be BASE64 encded). A creation with ZIP is recommend.

Path parameters

collection (required)
Path Parameter — Identifier of the collection
product (required)
Path Parameter — Identifier of the product

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success

Example data

Content-Type: application/json
{
  "type": "Feature",
  "geometry": {
      "type":"Polygon",
      "coordinates":[[[-180,-90],[180,-90],[180,90],[-180,90],[-180, -90]]]
  },
  "properties": {
    "eop:identifier" : "S2A_OPER_MSI_L1C_TL_SGS__20160929T154211_A006640_T32TPP_N02.04",
    "timeStart" : "2016-09-29T18:59:02Z",
    "timeEnd" : "2016-09-29T18:59:02Z",
    "originalPackageLocation" : "/var/data/sentinel2/2017/04/23/S2A_OPER_MSI_L1C_TL_SGS__20160929T154211_A006640_T32TPP_N02.04.zip",
    "thumbnailURL" : null,
    "quicklookURL" : null,
    "eop:parentIdentifier" : "SENTINEL2",
    "eop:productionStatus" : null,
    "eop:acquisitionType" : "NOMINAL",
    "eop:orbitNumber" : 65,
    "eop:orbitDirection" : "DESCENDING",
    "eop:track" : null,
    "eop:frame" : null,
    "eop:spwathIdentifier" : null,
    "opt:cloudCover" : 0,
    "opt:snowCover" : null,
    "eop:productQualityStatus" : null,
    "eop:productQualityDegradationStatus" : null,
    "eo:processorName" : null,
    "eop:processingCenter" : null,
    "eop:creationDate" : "2016-09-29T18:59:02Z",
    "eop:modificationDate" : null,
    "eop:processingDate" : null,
    "eop:sensorMode" : null,
    "eop:archivingCenter" : "DPA"
    "eop:processingMode" : "DATA_DRIVEN",
    "eop:availabilityTime" : null,
    "eop:acquisitionStation" : null,
    "eop:acquisitionSubtype" : null,
    "eop:startTimeFromAscendingNode" : null,
    "eop:completionTimeFromAscendingNode" : null,
    "eop:illuminationAzimuthAngle" : null,
    "eop:illuminationZenithAngle" : null,
    "eop:illuminationElevationAngle" : null,
    "sar:polarisationMode" : null,
    "sar:polarisationChannels" : null,
    "sar:antennaLookDirection" : null,
    "sar:minimumIncidenceAngle" : null,
    "sar:maximumIncidenceAngle" : null,
    "sar:dopplerFrequency" : null,
    "sar:incidenceAngleVariation" : null,
    "eop:resolution" : null,
    "ogcLinksHref": "http://host:port/geoserver/rest/oseo/collection/SENTINEL2/products/S2A_OPER_MSI_L1C_TL_SGS__20160929T154211_A006640_T32TPP_N02.04/ogcLinks",
    "metadataHref": "http://host:port/geoserver/rest/oseo/collection/SENTINEL2/prodcuts/S2A_OPER_MSI_L1C_TL_SGS__20160929T154211_A006640_T32TPP_N02.04metadata",
    "descriptionHref": "http://host:port/geoserver/rest/oseo/collection/SENTINEL2/products/S2A_OPER_MSI_L1C_TL_SGS__20160929T154211_A006640_T32TPP_N02.04/description",
    "thumbnailHref": "http://host:port/geoserver/rest/oseo/collection/SENTINEL2/prodcuts/S2A_OPER_MSI_L1C_TL_SGS__20160929T154211_A006640_T32TPP_N02.04/thumbnail",
    "granulesHref": "http://host:port/geoserver/rest/oseo/collection/SENTINEL2/prodcuts/S2A_OPER_MSI_L1C_TL_SGS__20160929T154211_A006640_T32TPP_N02.04/granules"
  }
}

404

The specified product cannot be found

Up
delete /collections/{collection}/products/{product}/granules
(collectionsCollectionProductsProductGranulesDelete)
Removes the product OGC links

Path parameters

collection (required)
Path Parameter — Identifier of the collection
product (required)
Path Parameter — Identifier of the product

Responses

200

OK

404

The specified collection or product cannot be found

Up
get /collections/{collection}/products/{product}/granules
(collectionsCollectionProductsProductGranulesGet)
Returns the list of a product granules

Path parameters

collection (required)
Path Parameter — Identifier of the collection
product (required)
Path Parameter — Identifier of the product

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success, returns the granules for the given product as a GeoJSON collection

Example data

Content-Type: application/json
{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "Polygon",
         "coordinate":[[[11.4772,40.5362],[11.5145,41.5243],[10.199,41.5456],[10.1811,40.5567],[11.4772,40.5362]]]
      },
      "properties": {
        "gid": 19,
        "location": "/efs/geoserver_data/coverages/sentinel/california/S2A_OPER_MSI_L1C_TL_SGS__20160117T141030_A002979_T32TPL_N02.01.tif"
      },
      "id": "GRANULE.19"
    }
  ]
}

404

The specified collection or product cannot be found

Up
put /collections/{collection}/products/{product}/granules
(collectionsCollectionProductsProductGranulesPut)
Updates/creates a product granules

Path parameters

collection (required)
Path Parameter — Identifier of the collection
product (required)
Path Parameter — Identifier of the product

Consumes

This API call consumes the following media types via the Content-Type request header:

Responses

200

Success

400

The payload provided does not match the expected structure (error message will provide details)

404

The specified collection or product cannot be found

Up
delete /collections/{collection}/products/{product}/metadata
(collectionsCollectionProductsProductMetadataDelete)
Removes the product metadata

Path parameters

collection (required)
Path Parameter — Identifier of the collection
product (required)
Path Parameter — Identifier of the product

Responses

200

OK

404

The specified product cannot be found

Up
get /collections/{collection}/products/{product}/metadata
(collectionsCollectionProductsProductMetadataGet)
Returns the O&M metadata of this product

Path parameters

collection (required)
Path Parameter — Identifier of the collection
product (required)
Path Parameter — Identifier of the product

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success

404

The specified product cannot be found

Up
put /collections/{collection}/products/{product}/metadata
(collectionsCollectionProductsProductMetadataPut)
Updates/creates a product O&M metadata

Path parameters

collection (required)
Path Parameter — Identifier of the collection
product (required)
Path Parameter — Identifier of the product

Consumes

This API call consumes the following media types via the Content-Type request header:

Responses

200

Success

400

The payload provided does not match the expected structure (error message will provide details)

404

The specified product cannot be found

Up
delete /collections/{collection}/products/{product}/ogcLinks
(collectionsCollectionProductsProductOgcLinksDelete)
Removes the product OGC links

Path parameters

collection (required)
Path Parameter — Identifier of the collection
product (required)
Path Parameter — Identifier of the product

Responses

200

OK

404

The specified collection or product cannot be found

Up
get /collections/{collection}/products/{product}/ogcLinks
(collectionsCollectionProductsProductOgcLinksGet)
Returns the list of a product OGC links

Path parameters

collection (required)
Path Parameter — Identifier of the collection
product (required)
Path Parameter — Identifier of the product

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success

Example data

Content-Type: application/json
[
 {
   "offering": "http://www.opengis.net/spec/owc/1.0/req/atom/wms",
   "method": "GET",
   "code": "GetCapabilities",
   "type": "application/xml",
   "href": "${BASE_URL}/sentinel2/S2A_OPER_MSI_L1C_TL_SGS__20160929T154211_A006640_T32TPP_N02.04/ows?service=wms&version=1.3.0&request=GetCapabilities"
 },
 {
   "offering": "http://www.opengis.net/spec/owc/1.0/req/atom/wms",
   "method": "GET",
   "code": "GetMap",
   "type": "image/jpeg",
   "href": "${BASE_URL}/sentinel2/S2A_OPER_MSI_L1C_TL_SGS__20160929T154211_A006640_T32TPP_N02.04/wms?SERVICE=WMS&VERSION=1.1.1&REQUEST=GetMap&FORMAT=image%2Fjpeg&STYLES&LAYERS=SENTINEL2-TCI&SRS=EPSG%3A4326&WIDTH=800&HEIGHT=600&BBOX=-180%2C-90%2C180%2C90"
 }
]

404

The specified collection or product cannot be found

Up
put /collections/{collection}/products/{product}/ogcLinks
(collectionsCollectionProductsProductOgcLinksPut)
Updates/creates a products OGC links

Path parameters

collection (required)
Path Parameter — Identifier of the collection
product (required)
Path Parameter — Identifier of the product

Consumes

This API call consumes the following media types via the Content-Type request header:

Responses

200

Success

400

The payload provided does not match the expected structure (error message will provide details)

404

The specified collection or product cannot be found

Up
put /collections/{collection}/products/{product}
(collectionsCollectionProductsProductPut)
Updates a product search attributes and OGC links

Path parameters

collection (required)
Path Parameter — Identifier of the collection
product (required)
Path Parameter — Identifier of the product

Consumes

This API call consumes the following media types via the Content-Type request header:

Responses

200

Success

400

The payload provided does not match the expected structure (error message will provide details)

404

The specified product cannot be found

Up
delete /collections/{collection}/products/{product}/thumbnail
(collectionsCollectionProductsProductThumbnailDelete)
Removes the product thumbnail

Path parameters

collection (required)
Path Parameter — Identifier of the collection
product (required)
Path Parameter — Identifier of the product

Responses

200

OK

404

The specified product cannot be found

Up
get /collections/{collection}/products/{product}/thumbnail
(collectionsCollectionProductsProductThumbnailGet)
Returns the thumbnail of this product

Path parameters

collection (required)
Path Parameter — Identifier of the collection
product (required)
Path Parameter — Identifier of the product

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success

404

The specified product cannot be found

Up
put /collections/{collection}/products/{product}/thumbnail
(collectionsCollectionProductsProductThumbnailPut)
Updates/creates a product thumbnail

Path parameters

collection (required)
Path Parameter — Identifier of the collection
product (required)
Path Parameter — Identifier of the product

Consumes

This API call consumes the following media types via the Content-Type request header:

Responses

200

Success

400

The payload provided does not match the expected structure (error message will provide details)

404

The specified product cannot be found

Up
put /collections/{collection}
(collectionsCollectionPut)
Updates a collection search attributes

Path parameters

collection (required)
Path Parameter — Identifier of the collection

Consumes

This API call consumes the following media types via the Content-Type request header:

Responses

200

Success

400

If any error is found in the json payload (details will be provided in the error message)

404

The specified collection cannot be found

Up
delete /collections/{collection}/thumbnail
(collectionsCollectionThumbnailDelete)
Removes the collection thumbnail

Path parameters

collection (required)
Path Parameter — Identifier of the collection

Responses

200

OK

404

The specified collection cannot be found

Up
get /collections/{collection}/thumbnail
(collectionsCollectionThumbnailGet)
Returns the thumbnail of this collection

Path parameters

collection (required)
Path Parameter — Identifier of the collection

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success

404

The specified product cannot be found

Up
put /collections/{collection}/thumbnail
(collectionsCollectionThumbnailPut)
Updates/creates a collection thumbnail

Path parameters

collection (required)
Path Parameter — Identifier of the collection

Consumes

This API call consumes the following media types via the Content-Type request header:

Responses

200

Success

404

The specified collection cannot be found

Up
get /collections
(collectionsGet)
Retrieves a list of all available collections (names and links)

Query parameters

offset (optional)
Query Parameter — First element for paged responses
limit (optional)
Query Parameter — Number of elements in page

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Success

Example data

Content-Type: application/json
{
  "collections" : [
        {
          "name" : "SENTINEL1",
          "href" : "http://host:port/geoserver/rest/oseo/collections/SENTINEL1.json",
          "search": "http://host:port/geoserver/oseo/description?parentId=SENTINEL1"
        },
        {
          "name" : "SENTINEL2",
          "href" : "http://host:port/geoserver/rest/oseo/collections/SENTINEL2.json",
          "search": "http://host:port/geoserver/oseo/description?parentId=SENTINEL2"
        }
    ]
}

Up
post /collections
(collectionsPost)

Creates a new collection via its search attributes and ogc links. The zip format accepts a set of files creating the collection in a single shot, and will contain the following files:

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

ogc_publish (optional)
Query Parameter — When set to true, instructs GeoServer to automatically publish the collection as a layer in the location GeoServer
workspace (optional)
Query Parameter — workspace where the collection will be published (if missing the default workspace will be used)
layer (optional)
Query Parameter — layer name used when publishing the collection (if missing the collection name will be used)

Responses

201

Created

400

If any error is found in the collection json payload

409

Returned if the target collection or layer is already there

Models

[ Jump to Methods ]

Table of Contents