GeoWebCache GridSets

A Grid Set is a set of tile grids associated with a coordinate reference system.
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

GwcGridSets

GwcGridSets

Up
delete /gridsets/{gridsetName}
Delete configured gridset (gridsetDelete)
Deletes a configured gridset from the server.

Path parameters

gridsetName (required)
Path Parameter — The name of the gridset to delete.

Responses

200

OK

404

Unknown gridset

Up
get /gridsets/{gridsetName}
Retrieve a configured gridset (gridsetGet)
Retrieves a single configured gridset definition.

Path parameters

gridsetName (required)
Path Parameter — The name of the gridset to retrieve.

Return type

GridSet

Example data

Content-Type: application/xml
"\n  EPSG:4326\n  A default WGS84 tile matrix set where the first zoom level covers the world with two tiles on the horizonal axis and one tile over the vertical axis and each subsequent zoom level is calculated by half the resolution of its previous one.\n  \n    4326\n  \n  \n    \n      -180.0\n      -90.0\n      180.0\n      90.0\n    \n  \n  false\n  \n    0.703125\n    0.3515625\n    0.17578125\n    0.087890625\n    0.0439453125\n    0.02197265625\n    0.010986328125\n    0.0054931640625\n    0.00274658203125\n    0.001373291015625\n    6.866455078125E-4\n    3.4332275390625E-4\n    1.71661376953125E-4\n    8.58306884765625E-5\n    4.291534423828125E-5\n    2.1457672119140625E-5\n    1.0728836059570312E-5\n    5.364418029785156E-6\n    2.682209014892578E-6\n    1.341104507446289E-6\n    6.705522537231445E-7\n    3.3527612686157227E-7\n  \n  111319.49079327358\n  2.8E-4\n  \n    EPSG:4326:0\n    EPSG:4326:1\n    EPSG:4326:2\n    EPSG:4326:3\n    EPSG:4326:4\n    EPSG:4326:5\n    EPSG:4326:6\n    EPSG:4326:7\n    EPSG:4326:8\n    EPSG:4326:9\n    EPSG:4326:10\n    EPSG:4326:11\n    EPSG:4326:12\n    EPSG:4326:13\n    EPSG:4326:14\n    EPSG:4326:15\n    EPSG:4326:16\n    EPSG:4326:17\n    EPSG:4326:18\n    EPSG:4326:19\n    EPSG:4326:20\n    EPSG:4326:21\n  \n  256\n  256\n  true\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 GridSet

Example data

Content-Type: application/xml

  EPSG:4326
  A default WGS84 tile matrix set where the first zoom level covers the world with two tiles on the horizonal axis and one tile over the vertical axis and each subsequent zoom level is calculated by half the resolution of its previous one.
  
    4326
  
  
    
      -180.0
      -90.0
      180.0
      90.0
    
  
  false
  
    0.703125
    0.3515625
    0.17578125
    0.087890625
    0.0439453125
    0.02197265625
    0.010986328125
    0.0054931640625
    0.00274658203125
    0.001373291015625
    6.866455078125E-4
    3.4332275390625E-4
    1.71661376953125E-4
    8.58306884765625E-5
    4.291534423828125E-5
    2.1457672119140625E-5
    1.0728836059570312E-5
    5.364418029785156E-6
    2.682209014892578E-6
    1.341104507446289E-6
    6.705522537231445E-7
    3.3527612686157227E-7
  
  111319.49079327358
  2.8E-4
  
    EPSG:4326:0
    EPSG:4326:1
    EPSG:4326:2
    EPSG:4326:3
    EPSG:4326:4
    EPSG:4326:5
    EPSG:4326:6
    EPSG:4326:7
    EPSG:4326:8
    EPSG:4326:9
    EPSG:4326:10
    EPSG:4326:11
    EPSG:4326:12
    EPSG:4326:13
    EPSG:4326:14
    EPSG:4326:15
    EPSG:4326:16
    EPSG:4326:17
    EPSG:4326:18
    EPSG:4326:19
    EPSG:4326:20
    EPSG:4326:21
  
  256
  256
  true

404

Unknown gridset

Up
put /gridsets/{gridsetName}
Create or update a configured gridset. (gridsetPut)
Creates a new configured gridset on the server, or modifies an existing gridset.

Path parameters

gridsetName (required)
Path Parameter — The name of the gridset to add or update.

Consumes

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

Request body

gridsetBody GridSet (required)
Body Parameter — The new gridset definition.

Responses

200

The gridset was successfully updated.

201

The gridset was successfully created.

Up
get /gridsets
Get a list of configured gridsets (gridsetsGet)
Displays a list of all configured gridsets on the server.

Return type

GridSets

Example data

Content-Type: application/xml
"\n  \n    EPSG:2163\n    \n  \n  \n    GlobalCRS84Pixel\n    \n  \n  \n    EPSG:4326\n    \n  \n  \n    GoogleCRS84Quad\n    \n  \n  \n    EPSG:900913\n    \n  \n  \n    GlobalCRS84Scale\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 GridSets

Example data

Content-Type: application/xml

  
    EPSG:2163
    
  
  
    GlobalCRS84Pixel
    
  
  
    EPSG:4326
    
  
  
    GoogleCRS84Quad
    
  
  
    EPSG:900913
    
  
  
    GlobalCRS84Scale
    
  


Models

[ Jump to Methods ]

Table of Contents

  1. GridSet - gridSet
  2. GridSetReference - gridSet
  3. GridSet_extent -
  4. GridSet_extent_coords -
  5. GridSet_resolutions -
  6. GridSet_resolutions_items -
  7. GridSet_scaleNames -
  8. GridSet_scaleNames_items -
  9. GridSet_srs -
  10. GridSets - gridSets

GridSet - gridSet Up

name (optional)
String Name of the gridset. Should be unique.
description (optional)
String Description of the gridset
srs (optional)
extent (optional)
alignTopLeft (optional)
Boolean Whether the y-coordinate of the tile origin is at the top (true) or bottom (false).
resolutions (optional)
metersPerUnit (optional)
BigDecimal The number of meters per coordinate unit.
pixelSize (optional)
BigDecimal The assumed pixel size of the display device, in meters.
scaleNames (optional)
tileHeight (optional)
Integer The height of a tile in pixels.
tileWidth (optional)
Integer The width of a tile in pixels.
yCoordinateFirst (optional)
Boolean By default the coordinates are {x,y}, this flag reverses the output for WMTS getcapabilities.

GridSetReference - gridSet Up

name (optional)
String Name of the gridset
link (optional)
String URL to gridset definition

GridSet_extent - Up

The gridset extent
coords (optional)
array[GridSet_extent_coords] The coordinates of the extent.

GridSet_extent_coords - Up

A coordinate of the extent.
double (optional)
BigDecimal The coordinate value.

GridSet_resolutions - Up

The resolutions of each gridset level
items (optional)

GridSet_resolutions_items - Up

The resolution of a gridset level.
double (optional)
BigDecimal The resolution value.

GridSet_scaleNames - Up

The scale names of each gridset level
items (optional)

GridSet_scaleNames_items - Up

The scale name of a gridset level.
double (optional)
String The scale name.

GridSet_srs - Up

The reference system of the gridSet
number (optional)
Integer The SRS number

GridSets - gridSets Up