GeoServer WMS Store Layers

A WMS store is a store whose source is another WMS. Also known as "Cascading WMS" or "External WMS". A WMS store layer is a layer from this store.
More information: http://geoserver.org/comm/
Contact Info: geoserver-users@sourceforge.net
Version: 1.0.0
BasePath:/geoserver/rest
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

Methods

[ Jump to Models ]

Table of Contents

WMSLayers

WMSLayers

Up
delete /workspaces/{workspace}/wmslayers/{wmslayer}
(deleteWMSStoreLayer)
Deletes a layer from the server.

Path parameters

workspace (required)
Path Parameter — Name of the workspace
wmslayer (required)
Path Parameter — Name of the layer to be deleted

Query parameters

recurse (optional)
Query Parameter — Recursively deletes all layers referenced by the specified wmslayer. Allowed values for this parameter are true or false. The default value is false. A request with 'recurse=false' will fail if any layers reference the wmslayer. default: false

Responses

200

OK

Up
delete /workspaces/{workspace}/wmslayers
(deleteWMSStoreLayers)
Invalid. Can only delete an individual layer.

Responses

405

Method Not Allowed

Up
delete /workspaces/{workspace}/wmsstores/{wmsstore}/wmslayers/{wmslayer}
(deleteWMSStoreStoreLayer)
Deletes a layer from the server.

Path parameters

workspace (required)
Path Parameter — Name of the workspace
wmsstore (required)
Path Parameter — Name of the store
wmslayer (required)
Path Parameter — Name of the layer to be deleted

Query parameters

recurse (optional)
Query Parameter — Recursively deletes all layers referenced by the specified wmslayer. Allowed values for this parameter are true or false. The default value is false. A request with 'recurse=false' will fail if any layers reference the wmslayer. default: false

Responses

200

OK

Up
delete /workspaces/{workspace}/wmsstores/{wmsstore}/wmslayers
(deleteWMSStoreStoreLayers)
Invalid. Can only delete an individual layer.

Responses

405

Method Not Allowed

Up
get /workspaces/{workspace}/wmslayers/{wmslayer}
(getWMSStoreLayer)
Retrieves an individual WMS layer. Use the "Accept:" header to specify format or append an extension to the endpoint (example "/workspaces/{workspace}/wmslayers/{wmslayer}.xml" for XML).

Path parameters

workspace (required)
Path Parameter — Name of the workspace
wmslayer (required)
Path Parameter — Name of the layer

Query parameters

quietOnNotFound (optional)
Query Parameter — When set to "true", will not log an exception when the style is not present. The 404 status code will still be returned. Allowable values are "true" or "false" (default).

Return type

WMSStoreLayerInfo

Example data

Content-Type: application/xml
"\n  dem\n  usgs:dem\n  \n    cite\n    \n  \n  Digital elevation model\n  USGS GTOPO30 digital elevation model\n  USGS GTOPO30 digital elevation model\n  \n    WCS\n    GeoTIFF\n    W100N40\n  \n  GEOGCS["WGS 84", 
\n  DATUM["World Geodetic System 1984", 
\n    SPHEROID["WGS 84", 6378137.0, 298.257223563, AUTHORITY["EPSG","7030"]], 
\n    AUTHORITY["EPSG","6326"]], 
\n  PRIMEM["Greenwich", 0.0, AUTHORITY["EPSG","8901"]], 
\n  UNIT["degree", 0.017453292519943295], 
\n  AXIS["Geodetic longitude", EAST], 
\n  AXIS["Geodetic latitude", NORTH], 
\n  AUTHORITY["EPSG","4326"]]\n  EPSG:4326\n  \n    -100.0\n    -60.000000000015994\n    -9.999999999980012\n    39.99999999999999\n    EPSG:4326\n  \n  \n    -100.0\n    -60.000000000015994\n    -9.999999999980012\n    39.99999999999999\n    EPSG:4326\n  \n  FORCE_DECLARED\n  true\n  \n    false\n  \n  \n    cite:altgs\n    \n  \n  dem_style\n  image/png\n  \n     image/png\n     image/jpeg\n     image/tiff\n     image/gif\n     image/geotiff\n     image/png8\n     image/tiff8\n     image/geotiff8\n  \n  \n     dem_style\n     another_dem_style\n  \n  1000000.0\n  1.0E7\n  false\n  \n     \n     \n  \n\n"

Example data

Content-Type: application/json
"{\"wmsLayer\":{\"name\":\"dem\",\"nativeName\":\"usgs:dem\",\"namespace\":{\"name\":\"cite\",\"href\":\"http://localhost:8080/geoserver/rest/namespaces/cite.json\"},\"title\":\"Digital elevation model\",\"description\":\"USGS GTOPO30 digital elevation model\",\"abstract\":\"USGS GTOPO30 digital elevation model\",\"keywords\":{\"string\":[\"WCS\",\"GeoTIFF\",\"W100N40\"]},\"nativeCRS\":\"GEOGCS[\\\"WGS 84\\\", \\r\\n  DATUM[\\\"World Geodetic System 1984\\\", \\r\\n    SPHEROID[\\\"WGS 84\\\", 6378137.0, 298.257223563, AUTHORITY[\\\"EPSG\\\",\\\"7030\\\"]], \\r\\n    AUTHORITY[\\\"EPSG\\\",\\\"6326\\\"]], \\r\\n  PRIMEM[\\\"Greenwich\\\", 0.0, AUTHORITY[\\\"EPSG\\\",\\\"8901\\\"]], \\r\\n  UNIT[\\\"degree\\\", 0.017453292519943295], \\r\\n  AXIS[\\\"Geodetic longitude\\\", EAST], \\r\\n  AXIS[\\\"Geodetic latitude\\\", NORTH], \\r\\n  AUTHORITY[\\\"EPSG\\\",\\\"4326\\\"]]\",\"srs\":\"EPSG:4326\",\"nativeBoundingBox\":{\"minx\":-100,\"maxx\":-60,\"miny\":-10,\"maxy\":40,\"crs\":\"EPSG:4326\"},\"latLonBoundingBox\":{\"minx\":-100,\"maxx\":-60,\"miny\":-10,\"maxy\":40,\"crs\":\"EPSG:4326\"},\"projectionPolicy\":\"FORCE_DECLARED\",\"enabled\":true,\"metadata\":{\"entry\":{\"@key\":\"cachingEnabled\",\"$\":\"false\"}},\"store\":{\"@class\":\"wmsStore\",\"name\":\"cite:altgs\",\"href\":\"http://localhost:8080/geoserver/rest/workspaces/cite/wmsstores/altgs.json\"},\"forcedRemoteStyle\":\"polygon\",\"preferredFormat\":\"image/png\",\"selectedRemoteFormats\":{\"string\":[\"image/png\",\"image/png; mode=8bit\",\"image/vnd.jpeg-png\",\"image/jpeg\",\"image/tiff\",\"image/gif\",\"image/geotiff\",\"image/gif;subtype=animated\",\"image/png8\",\"image/tiff8\",\"image/geotiff8\"]},\"selectedRemoteStyles\":{\"string\":[\"pophatch\",\"population-region\",\"polygon\",\"population\"]},\"minScale\":1000000,\"maxScale\":1.0E7,\"metadataBBoxRespected\":false,\"allAvailableRemoteStyles\":{\"style\":[{\"name\":\"population-region\",\"format\":\"sld\",\"languageVersion\":{\"version\":\"1.0.0\"},\"legend\":{\"width\":20,\"height\":20,\"format\":\"image/png\",\"onlineResource\":\"https://demo.geo-solutions.it:443/geoserver/wms?request=GetLegendGraphic&format=image%2Fpng&width=20&height=20&layer=topp%3Astates&style=population-region\"},\"metadata\":{\"entry\":{\"@key\":\"isRemote\",\"$\":\"true\"}}},{\"name\":\"polygon\",\"format\":\"sld\",\"languageVersion\":{\"version\":\"1.0.0\"},\"legend\":{\"width\":20,\"height\":20,\"format\":\"image/png\",\"onlineResource\":\"https://demo.geo-solutions.it:443/geoserver/wms?request=GetLegendGraphic&format=image%2Fpng&width=20&height=20&layer=topp%3Astates&style=polygon\"},\"metadata\":{\"entry\":{\"@key\":\"isRemote\",\"$\":\"true\"}}},{\"name\":\"population\",\"format\":\"sld\",\"languageVersion\":{\"version\":\"1.0.0\"},\"legend\":{\"width\":20,\"height\":20,\"format\":\"image/png\",\"onlineResource\":\"https://demo.geo-solutions.it:443/geoserver/wms?request=GetLegendGraphic&format=image%2Fpng&width=20&height=20&layer=topp%3Astates\"},\"metadata\":{\"entry\":{\"@key\":\"isRemote\",\"$\":\"true\"}}},{\"name\":\"pophatch\",\"format\":\"sld\",\"languageVersion\":{\"version\":\"1.0.0\"},\"legend\":{\"width\":20,\"height\":20,\"format\":\"image/png\",\"onlineResource\":\"https://demo.geo-solutions.it:443/geoserver/wms?request=GetLegendGraphic&format=image%2Fpng&width=20&height=20&layer=topp%3Astates&style=pophatch\"},\"metadata\":{\"entry\":{\"@key\":\"isRemote\",\"$\":\"true\"}}}]}}}\n"

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

OK WMSStoreLayerInfo

Example data

Content-Type: application/xml

  dem
  usgs:dem
  
    cite
    
  
  Digital elevation model
  USGS GTOPO30 digital elevation model
  USGS GTOPO30 digital elevation model
  
    WCS
    GeoTIFF
    W100N40
  
  GEOGCS["WGS 84", 
  DATUM["World Geodetic System 1984", 
    SPHEROID["WGS 84", 6378137.0, 298.257223563, AUTHORITY["EPSG","7030"]], 
    AUTHORITY["EPSG","6326"]], 
  PRIMEM["Greenwich", 0.0, AUTHORITY["EPSG","8901"]], 
  UNIT["degree", 0.017453292519943295], 
  AXIS["Geodetic longitude", EAST], 
  AXIS["Geodetic latitude", NORTH], 
  AUTHORITY["EPSG","4326"]]
  EPSG:4326
  
    -100.0
    -60.000000000015994
    -9.999999999980012
    39.99999999999999
    EPSG:4326
  
  
    -100.0
    -60.000000000015994
    -9.999999999980012
    39.99999999999999
    EPSG:4326
  
  FORCE_DECLARED
  true
  
    false
  
  
    cite:altgs
    
  
  dem_style
  image/png
  
     image/png
     image/jpeg
     image/tiff
     image/gif
     image/geotiff
     image/png8
     image/tiff8
     image/geotiff8
  
  
     dem_style
     another_dem_style
  
  1000000.0
  1.0E7
  false
  
     
     
  

Example data

Content-Type: application/json
{"wmsLayer":{"name":"dem","nativeName":"usgs:dem","namespace":{"name":"cite","href":"http://localhost:8080/geoserver/rest/namespaces/cite.json"},"title":"Digital elevation model","description":"USGS GTOPO30 digital elevation model","abstract":"USGS GTOPO30 digital elevation model","keywords":{"string":["WCS","GeoTIFF","W100N40"]},"nativeCRS":"GEOGCS[\"WGS 84\", \r\n  DATUM[\"World Geodetic System 1984\", \r\n    SPHEROID[\"WGS 84\", 6378137.0, 298.257223563, AUTHORITY[\"EPSG\",\"7030\"]], \r\n    AUTHORITY[\"EPSG\",\"6326\"]], \r\n  PRIMEM[\"Greenwich\", 0.0, AUTHORITY[\"EPSG\",\"8901\"]], \r\n  UNIT[\"degree\", 0.017453292519943295], \r\n  AXIS[\"Geodetic longitude\", EAST], \r\n  AXIS[\"Geodetic latitude\", NORTH], \r\n  AUTHORITY[\"EPSG\",\"4326\"]]","srs":"EPSG:4326","nativeBoundingBox":{"minx":-100,"maxx":-60,"miny":-10,"maxy":40,"crs":"EPSG:4326"},"latLonBoundingBox":{"minx":-100,"maxx":-60,"miny":-10,"maxy":40,"crs":"EPSG:4326"},"projectionPolicy":"FORCE_DECLARED","enabled":true,"metadata":{"entry":{"@key":"cachingEnabled","$":"false"}},"store":{"@class":"wmsStore","name":"cite:altgs","href":"http://localhost:8080/geoserver/rest/workspaces/cite/wmsstores/altgs.json"},"forcedRemoteStyle":"polygon","preferredFormat":"image/png","selectedRemoteFormats":{"string":["image/png","image/png; mode=8bit","image/vnd.jpeg-png","image/jpeg","image/tiff","image/gif","image/geotiff","image/gif;subtype=animated","image/png8","image/tiff8","image/geotiff8"]},"selectedRemoteStyles":{"string":["pophatch","population-region","polygon","population"]},"minScale":1000000,"maxScale":1.0E7,"metadataBBoxRespected":false,"allAvailableRemoteStyles":{"style":[{"name":"population-region","format":"sld","languageVersion":{"version":"1.0.0"},"legend":{"width":20,"height":20,"format":"image/png","onlineResource":"https://demo.geo-solutions.it:443/geoserver/wms?request=GetLegendGraphic&format=image%2Fpng&width=20&height=20&layer=topp%3Astates&style=population-region"},"metadata":{"entry":{"@key":"isRemote","$":"true"}}},{"name":"polygon","format":"sld","languageVersion":{"version":"1.0.0"},"legend":{"width":20,"height":20,"format":"image/png","onlineResource":"https://demo.geo-solutions.it:443/geoserver/wms?request=GetLegendGraphic&format=image%2Fpng&width=20&height=20&layer=topp%3Astates&style=polygon"},"metadata":{"entry":{"@key":"isRemote","$":"true"}}},{"name":"population","format":"sld","languageVersion":{"version":"1.0.0"},"legend":{"width":20,"height":20,"format":"image/png","onlineResource":"https://demo.geo-solutions.it:443/geoserver/wms?request=GetLegendGraphic&format=image%2Fpng&width=20&height=20&layer=topp%3Astates"},"metadata":{"entry":{"@key":"isRemote","$":"true"}}},{"name":"pophatch","format":"sld","languageVersion":{"version":"1.0.0"},"legend":{"width":20,"height":20,"format":"image/png","onlineResource":"https://demo.geo-solutions.it:443/geoserver/wms?request=GetLegendGraphic&format=image%2Fpng&width=20&height=20&layer=topp%3Astates&style=pophatch"},"metadata":{"entry":{"@key":"isRemote","$":"true"}}}]}}}

Up
get /workspaces/{workspace}/wmslayers
(getWMSStoreLayers)
Retrieves the WMS layers available on the server. Use the "Accept:" header to specify format or append an extension to the endpoint (example "/workspaces/{workspace}/wmslayers" for XML).

Path parameters

workspace (required)
Path Parameter — Name of the workspace

Query parameters

list (optional)
Query Parameter — Set "list=available" to see all possible layers in the store, not just ones currently published default: configured

Return type

WMSStoreLayersList

Example data

Content-Type: application/xml
"\n  \n    dem\n    \n  \n  \n    states\n    \n  \n\n"

Example data

Content-Type: application/json
"{\"wmsLayers\":{\"wmsLayer\":[{\"name\":\"dem\",\"href\":\"http:\\/\\/localhost:8080\\/geoserver\\/rest\\/workspaces\\/cite\\/wmsstores\\/altgs\\/wmslayers\\/dem.json\"},{\"name\":\"states\",\"href\":\"http:\\/\\/localhost:8080\\/geoserver\\/rest\\/workspaces\\/cite\\/wmsstores\\/altgs\\/wmslayers\\/states.json\"}]}}\n"

Example data

Content-Type: application/xml (list=available)
"\n  ne:basemap\n  ne:ne1\n  ne:boundary_lines_land\n  ne:states_provinces_lines\n  ne:populated_places\n  opengeo:countries\n  usgs:dem\n  ne:ocean\n  ne:roads\n  usa:states\n  ne:states_provinces_shp\n  ne:urban_areas\n\n"

Example data

Content-Type: application/json (list=available)
"{\"list\":{\"string\":[\"ne:basemap\",\"ne:ne1\",\"ne:boundary_lines_land\",\"ne:states_provinces_lines\",\"ne:populated_places\",\"opengeo:countries\",\"usgs:dem\",\"ne:ocean\",\"ne:roads\",\"usa:states\",\"ne:states_provinces_shp\",\"ne:urban_areas\"]}}\n"

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

OK WMSStoreLayersList

Example data

Content-Type: application/xml

  
    dem
    
  
  
    states
    
  

Example data

Content-Type: application/json
{"wmsLayers":{"wmsLayer":[{"name":"dem","href":"http:\/\/localhost:8080\/geoserver\/rest\/workspaces\/cite\/wmsstores\/altgs\/wmslayers\/dem.json"},{"name":"states","href":"http:\/\/localhost:8080\/geoserver\/rest\/workspaces\/cite\/wmsstores\/altgs\/wmslayers\/states.json"}]}}

Example data

Content-Type: application/xml (list=available)

  ne:basemap
  ne:ne1
  ne:boundary_lines_land
  ne:states_provinces_lines
  ne:populated_places
  opengeo:countries
  usgs:dem
  ne:ocean
  ne:roads
  usa:states
  ne:states_provinces_shp
  ne:urban_areas

Example data

Content-Type: application/json (list=available)
{"list":{"string":["ne:basemap","ne:ne1","ne:boundary_lines_land","ne:states_provinces_lines","ne:populated_places","opengeo:countries","usgs:dem","ne:ocean","ne:roads","usa:states","ne:states_provinces_shp","ne:urban_areas"]}}

Up
get /workspaces/{workspace}/wmsstores/{wmsstore}/wmslayers/{wmslayer}
(getWMSStoreStoreLayer)
Retrieves an individual WMS store layer for a given store. Use the "Accept:" header to specify format or append an extension to the endpoint (example "/workspaces/{workspace}/wmsstores/{wmsstore}/wmslayers/{wmslayer}.xml" for XML).

Path parameters

workspace (required)
Path Parameter — Name of the workspace
wmsstore (required)
Path Parameter — Name of the store
wmslayer (required)
Path Parameter — Name of the layer

Query parameters

quietOnNotFound (optional)
Query Parameter — When set to "true", will not log an exception when the style is not present. The 404 status code will still be returned. Allowable values are "true" or "false" (default).

Return type

WMSStoreLayerInfo

Example data

Content-Type: application/xml
"\n  dem\n  usgs:dem\n  \n    cite\n    \n  \n  Digital elevation model\n  USGS GTOPO30 digital elevation model\n  USGS GTOPO30 digital elevation model\n  \n    WCS\n    GeoTIFF\n    W100N40\n  \n  GEOGCS["WGS 84", 
\n  DATUM["World Geodetic System 1984", 
\n    SPHEROID["WGS 84", 6378137.0, 298.257223563, AUTHORITY["EPSG","7030"]], 
\n    AUTHORITY["EPSG","6326"]], 
\n  PRIMEM["Greenwich", 0.0, AUTHORITY["EPSG","8901"]], 
\n  UNIT["degree", 0.017453292519943295], 
\n  AXIS["Geodetic longitude", EAST], 
\n  AXIS["Geodetic latitude", NORTH], 
\n  AUTHORITY["EPSG","4326"]]\n  EPSG:4326\n  \n    -100.0\n    -60.000000000015994\n    -9.999999999980012\n    39.99999999999999\n    EPSG:4326\n  \n  \n    -100.0\n    -60.000000000015994\n    -9.999999999980012\n    39.99999999999999\n    EPSG:4326\n  \n  FORCE_DECLARED\n  true\n  \n    false\n  \n  \n    cite:altgs\n    \n  \n\n"

Example data

Content-Type: application/json
"{\"wmsLayer\":{\"name\":\"dem\",\"nativeName\":\"usgs:dem\",\"namespace\":{\"name\":\"cite\",\"href\":\"http://localhost:8080/geoserver/rest/namespaces/cite.json\"},\"title\":\"Digital elevation model\",\"description\":\"USGS GTOPO30 digital elevation model\",\"abstract\":\"USGS GTOPO30 digital elevation model\",\"keywords\":{\"string\":[\"WCS\",\"GeoTIFF\",\"W100N40\"]},\"nativeCRS\":\"GEOGCS[\\\"WGS 84\\\", \\r\\n  DATUM[\\\"World Geodetic System 1984\\\", \\r\\n    SPHEROID[\\\"WGS 84\\\", 6378137.0, 298.257223563, AUTHORITY[\\\"EPSG\\\",\\\"7030\\\"]], \\r\\n    AUTHORITY[\\\"EPSG\\\",\\\"6326\\\"]], \\r\\n  PRIMEM[\\\"Greenwich\\\", 0.0, AUTHORITY[\\\"EPSG\\\",\\\"8901\\\"]], \\r\\n  UNIT[\\\"degree\\\", 0.017453292519943295], \\r\\n  AXIS[\\\"Geodetic longitude\\\", EAST], \\r\\n  AXIS[\\\"Geodetic latitude\\\", NORTH], \\r\\n  AUTHORITY[\\\"EPSG\\\",\\\"4326\\\"]]\",\"srs\":\"EPSG:4326\",\"nativeBoundingBox\":{\"minx\":-100,\"maxx\":-60.000000000015994,\"miny\":-9.999999999980012,\"maxy\":39.99999999999999,\"crs\":\"EPSG:4326\"},\"latLonBoundingBox\":{\"minx\":-100,\"maxx\":-60.000000000015994,\"miny\":-9.999999999980012,\"maxy\":39.99999999999999,\"crs\":\"EPSG:4326\"},\"projectionPolicy\":\"FORCE_DECLARED\",\"enabled\":true,\"metadata\":{\"entry\":{\"@key\":\"cachingEnabled\",\"$\":\"false\"}},\"store\":{\"@class\":\"wmsStore\",\"name\":\"cite:altgs\",\"href\":\"http://localhost:8080/geoserver/rest/workspaces/cite/wmsstores/altgs.json\"}}}\n"

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

OK WMSStoreLayerInfo

Example data

Content-Type: application/xml

  dem
  usgs:dem
  
    cite
    
  
  Digital elevation model
  USGS GTOPO30 digital elevation model
  USGS GTOPO30 digital elevation model
  
    WCS
    GeoTIFF
    W100N40
  
  GEOGCS["WGS 84", 
  DATUM["World Geodetic System 1984", 
    SPHEROID["WGS 84", 6378137.0, 298.257223563, AUTHORITY["EPSG","7030"]], 
    AUTHORITY["EPSG","6326"]], 
  PRIMEM["Greenwich", 0.0, AUTHORITY["EPSG","8901"]], 
  UNIT["degree", 0.017453292519943295], 
  AXIS["Geodetic longitude", EAST], 
  AXIS["Geodetic latitude", NORTH], 
  AUTHORITY["EPSG","4326"]]
  EPSG:4326
  
    -100.0
    -60.000000000015994
    -9.999999999980012
    39.99999999999999
    EPSG:4326
  
  
    -100.0
    -60.000000000015994
    -9.999999999980012
    39.99999999999999
    EPSG:4326
  
  FORCE_DECLARED
  true
  
    false
  
  
    cite:altgs
    
  

Example data

Content-Type: application/json
{"wmsLayer":{"name":"dem","nativeName":"usgs:dem","namespace":{"name":"cite","href":"http://localhost:8080/geoserver/rest/namespaces/cite.json"},"title":"Digital elevation model","description":"USGS GTOPO30 digital elevation model","abstract":"USGS GTOPO30 digital elevation model","keywords":{"string":["WCS","GeoTIFF","W100N40"]},"nativeCRS":"GEOGCS[\"WGS 84\", \r\n  DATUM[\"World Geodetic System 1984\", \r\n    SPHEROID[\"WGS 84\", 6378137.0, 298.257223563, AUTHORITY[\"EPSG\",\"7030\"]], \r\n    AUTHORITY[\"EPSG\",\"6326\"]], \r\n  PRIMEM[\"Greenwich\", 0.0, AUTHORITY[\"EPSG\",\"8901\"]], \r\n  UNIT[\"degree\", 0.017453292519943295], \r\n  AXIS[\"Geodetic longitude\", EAST], \r\n  AXIS[\"Geodetic latitude\", NORTH], \r\n  AUTHORITY[\"EPSG\",\"4326\"]]","srs":"EPSG:4326","nativeBoundingBox":{"minx":-100,"maxx":-60.000000000015994,"miny":-9.999999999980012,"maxy":39.99999999999999,"crs":"EPSG:4326"},"latLonBoundingBox":{"minx":-100,"maxx":-60.000000000015994,"miny":-9.999999999980012,"maxy":39.99999999999999,"crs":"EPSG:4326"},"projectionPolicy":"FORCE_DECLARED","enabled":true,"metadata":{"entry":{"@key":"cachingEnabled","$":"false"}},"store":{"@class":"wmsStore","name":"cite:altgs","href":"http://localhost:8080/geoserver/rest/workspaces/cite/wmsstores/altgs.json"}}}

Up
get /workspaces/{workspace}/wmsstores/{wmsstore}/wmslayers
(getWMSStoreStoreLayers)
Retrieves the WMS store layers available in the given store. Use the "Accept:" header to specify format or append an extension to the endpoint (example "/workspaces/{workspace}/wmsstores/{wmsstore}/wmslayers.xml" for XML).

Path parameters

workspace (required)
Path Parameter — Name of the workspace
wmsstore (required)
Path Parameter — Name of the store

Query parameters

list (optional)
Query Parameter — Set "list=available" to see all possible layers in the store, not just ones currently published default: configured

Return type

WMSStoreLayersList

Example data

Content-Type: application/xml
"\n  \n    dem\n    \n  \n  \n    states\n    \n  \n\n"

Example data

Content-Type: application/json
"{\"wmsLayers\":{\"wmsLayer\":[{\"name\":\"dem\",\"href\":\"http:\\/\\/localhost:8080\\/geoserver\\/rest\\/workspaces\\/cite\\/wmsstores\\/altgs\\/wmslayers\\/dem.json\"},{\"name\":\"states\",\"href\":\"http:\\/\\/localhost:8080\\/geoserver\\/rest\\/workspaces\\/cite\\/wmsstores\\/altgs\\/wmslayers\\/states.json\"}]}}\n"

Example data

Content-Type: application/xml (list=available)
"\n  ne:basemap\n  ne:ne1\n  ne:boundary_lines_land\n  ne:states_provinces_lines\n  ne:populated_places\n  opengeo:countries\n  usgs:dem\n  ne:ocean\n  ne:roads\n  usa:states\n  ne:states_provinces_shp\n  ne:urban_areas\n\n"

Example data

Content-Type: application/json (list=available)
"{\"list\":{\"string\":[\"ne:basemap\",\"ne:ne1\",\"ne:boundary_lines_land\",\"ne:states_provinces_lines\",\"ne:populated_places\",\"opengeo:countries\",\"usgs:dem\",\"ne:ocean\",\"ne:roads\",\"usa:states\",\"ne:states_provinces_shp\",\"ne:urban_areas\"]}}\n"

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

OK WMSStoreLayersList

Example data

Content-Type: application/xml

  
    dem
    
  
  
    states
    
  

Example data

Content-Type: application/json
{"wmsLayers":{"wmsLayer":[{"name":"dem","href":"http:\/\/localhost:8080\/geoserver\/rest\/workspaces\/cite\/wmsstores\/altgs\/wmslayers\/dem.json"},{"name":"states","href":"http:\/\/localhost:8080\/geoserver\/rest\/workspaces\/cite\/wmsstores\/altgs\/wmslayers\/states.json"}]}}

Example data

Content-Type: application/xml (list=available)

  ne:basemap
  ne:ne1
  ne:boundary_lines_land
  ne:states_provinces_lines
  ne:populated_places
  opengeo:countries
  usgs:dem
  ne:ocean
  ne:roads
  usa:states
  ne:states_provinces_shp
  ne:urban_areas

Example data

Content-Type: application/json (list=available)
{"list":{"string":["ne:basemap","ne:ne1","ne:boundary_lines_land","ne:states_provinces_lines","ne:populated_places","opengeo:countries","usgs:dem","ne:ocean","ne:roads","usa:states","ne:states_provinces_shp","ne:urban_areas"]}}

Up
post /workspaces/{workspace}/wmslayers/{wmslayer}
(postWMSStoreLayer)
Invalid. Use PUT to edit a layer, or POST on the /wmslayers endpoint to add a new layer.

Responses

405

Method Not Allowed

Up
post /workspaces/{workspace}/wmslayers
(postWMSStoreLayers)
Publishes a new WMS store layer.

Path parameters

workspace (required)
Path Parameter — Name of the workspace

Consumes

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

Request body

WMSStoreLayerBody WMSStoreLayerInfo (required)
Body Parameter — Body of the WMS store layer

Responses

201

Created

Up
post /workspaces/{workspace}/wmsstores/{wmsstore}/wmslayers/{wmslayer}
(postWMSStoreStoreLayer)
Invalid. Use PUT to edit a layer, or POST on the /wmslayers endpoint to add a new layer.

Responses

405

Method Not Allowed

Up
post /workspaces/{workspace}/wmsstores/{wmsstore}/wmslayers
(postWMSStoreStoreLayers)
Publishes a new WMS store layer in the given store.

Path parameters

workspace (required)
Path Parameter — Name of the workspace
wmsstore (required)
Path Parameter — Name of the data store

Consumes

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

Request body

WMSStoreLayerBody WMSStoreLayerInfo (required)
Body Parameter — Body of the WMS store layer

Responses

201

Created

Up
put /workspaces/{workspace}/wmslayers/{wmslayer}
(putWMSStoreLayer)
Edits an existing WMS store layer.

Path parameters

workspace (required)
Path Parameter — Name of the workspace
wmslayer (required)
Path Parameter — Name of the layer to be edited

Consumes

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

Request body

WMSStoreLayerBody WMSStoreLayerInfo (required)
Body Parameter — Body of the WMS store layer

Query parameters

calculate (optional)
Query Parameter — Specifies whether to recalculate any bounding boxes for a wms layer. Some properties are automatically recalculated when necessary. In particular, the native bounding box is recalculated when the projection or projection policy are changed, and the lat/lon bounding box is recalculated when the native bounding box is recalculated, or when a new native bounding box is explicitly provided in the request. (The native and lat/lon bounding boxes are not automatically recalculated when they are explicitly included in the request.) In addition, the client may explicitly request a fixed set of fields to calculate, by including a comma-separated list of their names in the recalculate parameter. The empty parameter 'recalculate=' is useful avoid slow recalculation when operating against large datasets as 'recalculate=' avoids calculating any fields, regardless of any changes to projection, projection policy, etc. The nativebbox parameter 'recalculate=nativebbox' is used recalculates the native bounding box, while avoiding recalculating the lat/lon bounding box. Recalculate parameters can be used in together - 'recalculate=nativebbox,latlonbbox' can be used after a bulk import to to recalculates both the native bounding box and the lat/lon bounding box.

Responses

201

Created

Up
put /workspaces/{workspace}/wmslayers
(putWMSStoreLayers)
Invalid. Use POST for adding a new layer, or PUT on an individual layer to edit it.

Responses

405

Method Not Allowed

Up
put /workspaces/{workspace}/wmsstores/{wmsstore}/wmslayers/{wmslayer}
(putWMSStoreStoreLayer)
Edits an existing WMS store layer.

Path parameters

workspace (required)
Path Parameter — Name of the workspace
wmsstore (required)
Path Parameter — Name of the store
wmslayer (required)
Path Parameter — Name of the layer to be edited

Consumes

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

Request body

WMSStoreLayerBody WMSStoreLayerInfo (required)
Body Parameter — Body of the WMS store layer

Query parameters

calculate (optional)
Query Parameter — Specifies whether to recalculate any bounding boxes for a wms layer. Some properties are automatically recalculated when necessary. In particular, the native bounding box is recalculated when the projection or projection policy are changed, and the lat/lon bounding box is recalculated when the native bounding box is recalculated, or when a new native bounding box is explicitly provided in the request. (The native and lat/lon bounding boxes are not automatically recalculated when they are explicitly included in the request.) In addition, the client may explicitly request a fixed set of fields to calculate, by including a comma-separated list of their names in the recalculate parameter. The empty parameter 'recalculate=' is useful avoid slow recalculation when operating against large datasets as 'recalculate=' avoids calculating any fields, regardless of any changes to projection, projection policy, etc. The nativebbox parameter 'recalculate=nativebbox' is used recalculates the native bounding box, while avoiding recalculating the lat/lon bounding box. Recalculate parameters can be used in together - 'recalculate=nativebbox,latlonbbox' can be used after a bulk import to to recalculates both the native bounding box and the lat/lon bounding box.

Responses

201

Created

Up
put /workspaces/{workspace}/wmsstores/{wmsstore}/wmslayers
(putWMSStoreStoreLayers)
Invalid. Use POST for adding a new layer, or PUT on an individual layer to edit it.

Responses

405

Method Not Allowed

Models

[ Jump to Methods ]

Table of Contents

  1. MetadataEntry - entry
  2. StyleInfo - style
  3. StyleInfo_languageVersion -
  4. StyleInfo_legend -
  5. WMSStoreLayerInfo - wmsLayer
  6. WMSStoreLayerInfo_dataLinks -
  7. WMSStoreLayerInfo_dataLinks_metadataLink -
  8. WMSStoreLayerInfo_keywords -
  9. WMSStoreLayerInfo_latLonBoundingBox -
  10. WMSStoreLayerInfo_metadatalinks -
  11. WMSStoreLayerInfo_metadatalinks_metadataLink -
  12. WMSStoreLayerInfo_namespace -
  13. WMSStoreLayerInfo_nativeBoundingBox -
  14. WMSStoreLayerInfo_store -
  15. WMSStoreLayersAvailableList - list
  16. WMSStoreLayersList - wmsLayers
  17. wmsLayer -

MetadataEntry - entry Up

@key (optional)
String Key used for metadata entry
Enum:
regionateStrategy
regionateFeatureLimit
cacheAgeMax
cachingEnabled
regionateAttribute
indexingEnabled
dirName
text (optional)
String Value of given key

StyleInfo - style Up

name (optional)
String Name of remote style
format (optional)
String format of style
example: sld
languageVersion (optional)
legend (optional)

StyleInfo_languageVersion - Up

version (optional)
String versioon of format
example: 1.0.0

StyleInfo_legend - Up

width (optional)
BigDecimal width of remote legend graphic
height (optional)
BigDecimal height of remote legend graphics
format (optional)
String image format of legend graphic
example: image/png
onlineResource (optional)
String GetLegendGraphic request URL

WMSStoreLayerInfo - wmsLayer Up

name (optional)
String Name of the layer, corresponding to the published name of the resource
nativeName (optional)
String Name of the layer as known on the remote WMS
namespace (optional)
title (optional)
String Title of the layer
abstract (optional)
String Description of the layer
description (optional)
String Same as abstract
keywords (optional)
array[WMSStoreLayerInfo_keywords] Collection of keywords associated with the layer
metadatalinks (optional)
dataLinks (optional)
nativeCRS (optional)
String Native coordinate reference system object in WKT
srs (optional)
String Identifier of coordinate reference system
nativeBoundingBox (optional)
latLonBoundingBox (optional)
projectionPolicy (optional)
String How to handle the coordinate reference system (native versus declared)
Enum:
FORCE_DECLARED
REPROJECT_TO_DECLARE
NONE
enabled (optional)
Boolean Whether the layer is enabled
metadata (optional)
array[MetadataEntry] A list of key/value metadata pairs.
store (optional)
forcedRemoteStyle (optional)
String Remote style to be used in remote GetMap request.
selectedRemoteFormats (optional)
array[String] Additional list of image formats supported by remote WMS Server.
preferredFormat (optional)
String Output image format to be used in remote GetMap request
selectedRemoteStyles (optional)
array[String] Additional list of remote styles that can be used to remote GetMap requests.
allAvailableRemoteStyles (optional)
array[StyleInfo] List of complete style info objects that contain name, sld format and GetLegendRequests.
minScale (optional)
BigDecimal minimum scale denominator, works like Scale denomintors in SLD.
maxScale (optional)
BigDecimal maximum scale denominator, works like Scale denomintors in SLD.
metadataBBoxRespected (optional)
Boolean An optimization that skips remote GetMap requests if requested Map is outside advertised bounds.

WMSStoreLayerInfo_dataLinks - Up

Wraps a collection of data links
metadataLink (optional)

WMSStoreLayerInfo_dataLinks_metadataLink - Up

type (optional)
String MIME type
content (optional)
String Link URL

WMSStoreLayerInfo_keywords - Up

string (optional)
String Keyword

WMSStoreLayerInfo_latLonBoundingBox - Up

Bounds of the layer in latitude / longitude. This value represents a "fixed value" and is not calculated.
minx (optional)
BigDecimal Min x coordinate
maxx (optional)
BigDecimal Max x coordinate
miny (optional)
BigDecimal Min y coordinate
maxy (optional)
BigDecimal Max y coordinate
crs (optional)
String Coordinate reference system object of the bounding box

WMSStoreLayerInfo_metadatalinks - Up

Wraps a collection of metadata links
metadataLink (optional)

WMSStoreLayerInfo_metadatalinks_metadataLink - Up

type (optional)
String MIME type
metadataType (optional)
String Type of metadata such as "FGDC"
content (optional)
String Link URL

WMSStoreLayerInfo_namespace - Up

Namespace of the layer
name (optional)
String Name of the namespace
link (optional)
String URL to the namespace representation.

WMSStoreLayerInfo_nativeBoundingBox - Up

Bounds of the layer in its declared CRS.
minx (optional)
BigDecimal Min x coordinate
maxx (optional)
BigDecimal Max x coordinate
miny (optional)
BigDecimal Min y coordinate
maxy (optional)
BigDecimal Max y coordinate
crs (optional)
String Coordinate reference system of the bounding box

WMSStoreLayerInfo_store - Up

Store conaining the resource
@class (optional)
String Class of the store
name (optional)
String Name of the store
href (optional)
String URL to the data store

WMSStoreLayersAvailableList - list Up

WMSStoreLayersList - wmsLayers Up

wmsLayer - Up

name (optional)
String Name of the layer
link (optional)
String URL of the layer representation