GeoWebCache Layers

A layer is a published resource (feature type or coverage).
More information: http://geoserver.org/comm/
Contact Info: geoserver-users@sourceforge.net
Version: 1.0.0
BasePath:/geoserver/gwc/rest
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

Methods

[ Jump to Models ]

Table of Contents

GwcLayers

GwcLayers

Up
get /layers
Get a list of cached layers (layersGet)
Displays a list of all cached layers on the server.

Return type

Layers

Example data

Content-Type: application/xml
"\n  \n    opengeo:countries\n    \n  \n  \n    usa:states\n    \n  \n\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 Layers

Example data

Content-Type: application/xml

  
    opengeo:countries
    
  
  
    usa:states
    
  


Up
delete /layers/{layerName}
Delete cached layer (layersNameDelete)
Deletes a cached layer from the server.

Path parameters

layerName (required)
Path Parameter — The name of the layer to delete.

Responses

200

OK

Up
get /layers/{layerName}
Retrieve a cached layer (layersNameGet)
Retrieves a single cached layer definition.

Path parameters

layerName (required)
Path Parameter — The name of the layer to retrieve.

Return type

Layer

Example data

Content-Type: application/xml
"\n  LayerInfoImpl--3a33e7d0:1400d3d823c:-7fdf\n  true\n  true\n  opengeo:countries\n  \n    image/png\n    image/jpeg\n  \n  \n    \n      EPSG:900913\n    \n    \n      EPSG:4326\n    \n  \n  \n    4\n    4\n  \n  0\n  0\n  \n    \n      STYLES\n      \n    \n  \n  0\n\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 Layer

Example data

Content-Type: application/xml

  LayerInfoImpl--3a33e7d0:1400d3d823c:-7fdf
  true
  true
  opengeo:countries
  
    image/png
    image/jpeg
  
  
    
      EPSG:900913
    
    
      EPSG:4326
    
  
  
    4
    4
  
  0
  0
  
    
      STYLES
      
    
  
  0

404

Unknown layer

Up
post /layers/{layerName}
Modify a cached layer (Deprecated). (layersNamePost)
Modifies an existing cached layer on the server. Deprecated - use PUT instead.

Path parameters

layerName (required)
Path Parameter — The name of the layer to modify.

Consumes

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

Request body

layerBody Layer (required)
Body Parameter — The updated layer definition.

Responses

200

The layer was successfully updated.

Up
put /layers/{layerName}
Create or update a cached layer. (layersNamePut)
Creates a new cached layer on the server, or modifies an existing cached layer.

Path parameters

layerName (required)
Path Parameter — The name of the layer to add.

Consumes

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

Request body

layerBody Layer (required)
Body Parameter — The new layer definition.

Responses

200

The layer was successfully updated.

201

The layer was successfully created.

Models

[ Jump to Methods ]

Table of Contents

  1. Layer - layer
  2. LayerReference - layer
  3. Layer_gridSubsets -
  4. Layer_gridSubsets_gridSubset -
  5. Layer_gridSubsets_gridSubset_extent -
  6. Layers - layers

Layer - layer Up

id (optional)
String Unique ID of the layer.
enabled (optional)
Boolean Indicates whether tile caching is enabled for this layer.
inMemoryCached (optional)
Boolean Determines if the layer is cached.
name (optional)
String The name of the layer.
mimeFormats (optional)
array[String] List of formats to be supported (ie. img/jpeg...).
gridSubsets (optional)
metaWidthHeight (optional)
Integer The metatiling factors used for this layer.
expireCache (optional)
Integer How old the tile may be before it is refetched from the backend.
expireClients (optional)
Integer The HTTP expiration header sent to client.
parameterFilters (optional)
Object A list of parameter filters, meaning parameters the client may specify that GWC will forward to the backend.
gutter (optional)
Integer The gutter is a buffer around the image that is sliced away when saving the tiles to disk.

LayerReference - layer Up

name (optional)
String Name of layer
link (optional)
String URL to layer definition

Layer_gridSubsets - Up

The grid definitions contain information about the SRS, the maximum extent for this SRS and the bounds of your data.
gridSubset (optional)

Layer_gridSubsets_gridSubset - Up

Contains the values for gridSetName.
gridSetName (optional)
String This name must match the name of the parent gridSet exactly.
extent (optional)
zoomStart (optional)
Integer If the the layer does not make sense at high zoom levels you can define a starting point here.
zoomStop (optional)
Integer If the layer does not contain features that make sense to show when zoomed in then you can set the stop level here.

Layer_gridSubsets_gridSubset_extent - Up

These bounds define the subset of the extent that this grid subset covers.
bounds (optional)
BigDecimal Coordinates used to set bounds uses double(ie. {-x,-y,x,y})

Layers - layers Up