GeoServer StructuredCoverageStores
A structured coverage store allows description of its "granules" and management of them.
Version: 1.0.0
BasePath:/geoserver/rest
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
[ Jump to Models ]
Table of Contents
Up
delete /workspaces/{workspace}/coveragestores/{store}/coverages/{coverage}/index
(deleteCoverageStores)
Invalid, the index cannot be created or modified
Responses
401
Unauthorized
405
Method Not Allowed
Up
delete /workspaces/{workspace}/coveragestores/{store}/coverages/{coverage}/index/granules/{granuleId}
(deleteStructuredCoverageGranule)
Allows removing the specified granule
Path parameters
workspace (required)
Path Parameter — The name of the worskpace containing the coverage stores.
store (required)
Path Parameter — The name of the store to be retrieved
coverage (required)
Path Parameter — The name of the coverage to be retrieved
granuleId (required)
Path Parameter — The granule ID
Query parameters
purge (optional)
Query Parameter — The purge parameter specifies if and how the underlying raster data source is deleted. Allowable values for this parameter are "none", "metadata" and "all". When set to "none" data and auxiliary files are preserved, only the registration in the mosaic is removed When set to "metadata" delete only auxiliary files and metadata (e.g. NetCDF sidecar indexes). It’s recommended when data files (such as granules) should not be deleted from disk. Finally, when set to "all" both data and auxiliary files are removed.
updateBBox (optional)
Query Parameter — When set to "true", triggers re-calculation of the layer native bbox. Defaults to "false".
Responses
200
OK
401
Unauthorized
Up
delete /workspaces/{workspace}/coveragestores/{store}/coverages/{coverage}/index/granules
(deleteStructuredCoverageGranules)
Allows removing one or more granules from the index
Path parameters
workspace (required)
Path Parameter — The name of the worskpace containing the coverage stores.
store (required)
Path Parameter — The name of the store to be retrieved
coverage (required)
Path Parameter — The name of the coverage to be retrieved
Query parameters
filter (optional)
Query Parameter — A CQL filter to reduce the returned granules
purge (optional)
Query Parameter — The purge parameter specifies if and how the underlying raster data source is deleted. Allowable values for this parameter are "none", "metadata" and "all". When set to "none" data and auxiliary files are preserved, only the registration in the mosaic is removed When set to "metadata" delete only auxiliary files and metadata (e.g. NetCDF sidecar indexes). It’s recommended when data files (such as granules) should not be deleted from disk. Finally, when set to "all" both data and auxiliary files are removed.
updateBBox (optional)
Query Parameter — When set to "true", triggers re-calculation of the layer native bbox. Defaults to "false".
Responses
200
OK
405
Method Not Allowed
Up
get /workspaces/{workspace}/coveragestores/{store}/coverages/{coverage}/index/granules/{granuleId}
Get the attributes of a particular granule (getStructuredCoverageGranule)
Displays a list of all the attributes associated to a particular coverage's granule. Use the "Accept:" header to specify format or append an extension to the endpoint (example "/index.xml" for XML). Defaults to XML representation. The XML output is actually WFS 1.0 GML, while the JSON output is GeoJSON
Path parameters
workspace (required)
Path Parameter — The name of the worskpace containing the coverage stores.
store (required)
Path Parameter — The name of the store to be retrieved
coverage (required)
Path Parameter — The name of the coverage to be retrieved
granuleId (required)
Path Parameter — The granule ID
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/json
application/xml
Responses
200
OK
Example data
Content-Type: application/json
{
"type": "FeatureCollection",
"bbox": [
0.23722068851276978,
40.562080748421806,
14.592757149389236,
44.55808294568743
],
"crs": {
"type": "name",
"properties": {"name": "EPSG:4326"}
},
"features": [
{
"type": "Feature",
"geometry": {
"type": "MultiPolygon",
"coordinates": [[ [
[
0.2372,
40.5621
],
[
0.2372,
44.5581
],
[
14.5928,
44.5581
],
[
14.5928,
40.5621
],
[
0.2372,
40.5621
]
]]]
},
"properties": {
"location": "NCOM_wattemp_000_20081101T0000000_12.tiff",
"ingestion": "2008-11-01T00:00:00.000+0000",
"elevation": 0
},
"id": "watertemp.1"
}
]
}
Example data
Content-Type: application/xml
0.23722068851276978
40.562080748421806
14.592757149389236
44.55808294568743
0.237221,40.562081 14.592757,44.558083
0.237221,40.562081 0.237221,44.558083 14.592757,44.558083 14.592757,40.562081 0.237221,40.562081
NCOM_wattemp_000_20081101T0000000_12.tiff
2008-11-01T00:00:00Z
0
401
Unauthorized
Up
get /workspaces/{workspace}/coveragestores/{store}/coverages/{coverage}/index/granules
Get the attributes associated to the granules (getStructuredCoverageGranules)
Displays a list of all the attributes associated to a particular coverage's granules. Use the "Accept:" header to specify format or append an extension to the endpoint (example "/index.xml" for XML). Defaults to XML representation. The XML output is actually WFS 1.0 GML, while the JSON output is GeoJSON
Path parameters
workspace (required)
Path Parameter — The name of the worskpace containing the coverage stores.
store (required)
Path Parameter — The name of the store to be retrieved
coverage (required)
Path Parameter — The name of the coverage to be retrieved
Query parameters
filter (optional)
Query Parameter — A CQL filter to reduce the returned granules
offset (optional)
Query Parameter — Used for paging, the start of the current page default: 0
limit (optional)
Query Parameter — Used for paging, the number of items to be returned
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/json
application/xml
Responses
200
OK
Example data
Content-Type: application/json
{
"type": "FeatureCollection",
"bbox": [
0.23722068851276978,
40.562080748421806,
14.592757149389236,
44.55808294568743
],
"crs": {
"type": "name",
"properties": {"name": "EPSG:4326"}
},
"features": [
{
"type": "Feature",
"geometry": {
"type": "MultiPolygon",
"coordinates": [[ [
[
0.2372,
40.5621
],
[
0.2372,
44.5581
],
[
14.5928,
44.5581
],
[
14.5928,
40.5621
],
[
0.2372,
40.5621
]
]]]
},
"properties": {
"location": "NCOM_wattemp_000_20081101T0000000_12.tiff",
"ingestion": "2008-11-01T00:00:00.000+0000",
"elevation": 0
},
"id": "watertemp.1"
},
{
"type": "Feature",
"geometry": {
"type": "MultiPolygon",
"coordinates": [[ [
[
0.2372,
40.5621
],
[
0.2372,
44.5581
],
[
14.5928,
44.5581
],
[
14.5928,
40.5621
],
[
0.2372,
40.5621
]
]]]
},
"properties": {
"location": "NCOM_wattemp_000_20081031T0000000_12.tiff",
"ingestion": "2008-10-31T00:00:00.000+0000",
"elevation": 0
},
"id": "watertemp.2"
}
]
}
Example data
Content-Type: application/xml
0.23722068851276978
40.562080748421806
14.592757149389236
44.55808294568743
0.237221,40.562081 14.592757,44.558083
0.237221,40.562081 0.237221,44.558083 14.592757,44.558083 14.592757,40.562081 0.237221,40.562081
NCOM_wattemp_000_20081101T0000000_12.tiff
2008-11-01T00:00:00Z
0
0.237221,40.562081 14.592757,44.558083
0.237221,40.562081 0.237221,44.558083 14.592757,44.558083 14.592757,40.562081 0.237221,40.562081
NCOM_wattemp_000_20081031T0000000_12.tiff
2008-10-31T00:00:00Z
0
401
Unauthorized
Up
get /workspaces/{workspace}/coveragestores/{store}/coverages/{coverage}/index
Get the information schema attached to the granules (getStructuredCoverageIndex)
Displays a list of all the attributes associated to a particular coverage's granules. Use the "Accept:" header to specify format or append an extension to the endpoint (example "/index.xml" for XML). Defaults to XML representation.
Path parameters
workspace (required)
Path Parameter — The name of the worskpace containing the coverage stores.
store (required)
Path Parameter — The name of the store to be retrieved
coverage (required)
Path Parameter — The name of the coverage to be retrieved
Return type
Example data
Content-Type: application/json
"{\"Schema\": {\n \"attributes\": {\"Attribute\": [\n {\n \"name\": \"the_geom\",\n \"minOccurs\": 0,\n \"maxOccurs\": 1,\n \"nillable\": true,\n \"binding\": \"org.locationtech.jts.geom.MultiPolygon\"\n },\n {\n \"name\": \"location\",\n \"minOccurs\": 0,\n \"maxOccurs\": 1,\n \"nillable\": true,\n \"binding\": \"java.lang.String\",\n \"length\": 254\n },\n {\n \"name\": \"ingestion\",\n \"minOccurs\": 0,\n \"maxOccurs\": 1,\n \"nillable\": true,\n \"binding\": \"java.util.Date\",\n \"length\": 8\n },\n {\n \"name\": \"elevation\",\n \"minOccurs\": 0,\n \"maxOccurs\": 1,\n \"nillable\": true,\n \"binding\": \"java.lang.Integer\",\n \"length\": 9\n }\n ]},\n \"href\": \"http://localhost:8080/geoserver/restng/workspaces/wcs/coveragestores/watertemp/coverages/watertemp/index/granules.json\"\n }} \n"
Example data
Content-Type: application/xml
"\n\n \n \n the_geom\n 0\n 1\n true\n org.locationtech.jts.geom.MultiPolygon\n \n \n location\n 0\n 1\n true\n java.lang.String\n 254\n \n \n ingestion\n 0\n 1\n true\n java.util.Date\n 8\n \n \n elevation\n 0\n 1\n true\n java.lang.Integer\n 9\n \n \n \n\n"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/json
application/xml
Responses
200
OK
Schema
Example data
Content-Type: application/json
{"Schema": {
"attributes": {"Attribute": [
{
"name": "the_geom",
"minOccurs": 0,
"maxOccurs": 1,
"nillable": true,
"binding": "org.locationtech.jts.geom.MultiPolygon"
},
{
"name": "location",
"minOccurs": 0,
"maxOccurs": 1,
"nillable": true,
"binding": "java.lang.String",
"length": 254
},
{
"name": "ingestion",
"minOccurs": 0,
"maxOccurs": 1,
"nillable": true,
"binding": "java.util.Date",
"length": 8
},
{
"name": "elevation",
"minOccurs": 0,
"maxOccurs": 1,
"nillable": true,
"binding": "java.lang.Integer",
"length": 9
}
]},
"href": "http://localhost:8080/geoserver/restng/workspaces/wcs/coveragestores/watertemp/coverages/watertemp/index/granules.json"
}}
Example data
Content-Type: application/xml
the_geom
0
1
true
org.locationtech.jts.geom.MultiPolygon
location
0
1
true
java.lang.String
254
ingestion
0
1
true
java.util.Date
8
elevation
0
1
true
java.lang.Integer
9
401
Unauthorized
Up
post /workspaces/{workspace}/coveragestores/{store}/coverages/{coverage}/index/granules/{granuleId}
(postStructuredCoverageGranule)
Invalid, the granules cannot harvested here, use a POST request on /workspaces/{workspace}/coveragestores/{store}
Responses
401
Unauthorized
405
Method Not Allowed
Up
post /workspaces/{workspace}/coveragestores/{store}/coverages/{coverage}/index/granules
(postStructuredCoverageGranules)
Invalid, the granules cannot harvested here, use a POST request on /workspaces/{workspace}/coveragestores/{store}
Responses
401
Unauthorized
405
Method Not Allowed
Up
post /workspaces/{workspace}/coveragestores/{store}/coverages/{coverage}/index
(postStructuredCoverageIndex)
Invalid, the index cannot be created or modified
Responses
401
Unauthorized
405
Method Not Allowed
Up
put /workspaces/{workspace}/coveragestores/{store}/coverages/{coverage}/index/granules/{granuleId}
(putStructuredCoverageGranule)
Invalid, the granules cannot harvested here, use a POST request on /workspaces/{workspace}/coveragestores/{store}
Responses
401
Unauthorized
405
Method Not Allowed
Up
put /workspaces/{workspace}/coveragestores/{store}/coverages/{coverage}/index/granules
(putStructuredCoverageGranules)
Invalid, the granules cannot harvested here, use a POST request on /workspaces/{workspace}/coveragestores/{store}
Responses
401
Unauthorized
405
Method Not Allowed
Up
put /workspaces/{workspace}/coveragestores/{store}/coverages/{coverage}/index
(putStructuredCoverageIndex)
Invalid, the index cannot be created or modified
Responses
401
Unauthorized
405
Method Not Allowed
[ Jump to Methods ]
Table of Contents
Attribute
-
Schema
-
An attribute description
name (optional)
minOccurs (optional)
Integer Minimum number of occurrences (0 for optional attribute)
maxOccurs (optional)
Integer Maximumn number of occurrences (normally 1)
nillable (optional)
Boolean If the attribute can be missing
binding (optional)
String Name of the java class for the attribute
length (optional)
attributes
link
String Link to the list of granules