WPS download configuration

The WPS download module allows to perform large data, map and animation downloads sing asynchronous requests
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

WPS

WPS

Up
get /services/wps/download
(getDownloadServiceConfiguration)
Retrieves the WPS Download configuration.

Return type

DownloadServiceConfiguration

Example data

Content-Type: application/xml
"\n  100000\n  64000000\n  64000000\n  52428800\n  4\n  1000\n\n"

Example data

Content-Type: application/json
"{\"DownloadServiceConfiguration\": {\n  \"maxFeatures\": 123,\n  \"rasterSizeLimits\": 456000,\n  \"writeLimits\": 789000,\n  \"hardOutputLimit\": 123456,\n  \"compressionLevel\": 8,\n  \"maxAnimationFrames\": 56\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 DownloadServiceConfiguration

Example data

Content-Type: application/xml

  100000
  64000000
  64000000
  52428800
  4
  1000

Example data

Content-Type: application/json
{"DownloadServiceConfiguration": {
  "maxFeatures": 123,
  "rasterSizeLimits": 456000,
  "writeLimits": 789000,
  "hardOutputLimit": 123456,
  "compressionLevel": 8,
  "maxAnimationFrames": 56
}}

Up
put /services/wps/download
(getDownloadServiceConfiguration_1)
Retrieves the WPS Download configuration.

Consumes

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

Request body

getDownloadServiceConfigurationBody DownloadServiceConfiguration (required)
Body Parameter — Body of the WPS download configuration

Responses

200

Updated

Models

[ Jump to Methods ]

Table of Contents

  1. DownloadServiceConfiguration -

DownloadServiceConfiguration - Up

maxFeatures (optional)
BigDecimal maximum number of features to download
rasterSizeLimits (optional)
BigDecimal maximum pixel size of the Raster to read
writeLimits (optional)
BigDecimal maximum raw raster size in bytes (a limit of how much space can a raster take in memory). For a given raster, its raw size in bytes is calculated by multiplying pixel number (raster_width x raster_height) with the accumulated sum of each band’s pixel sample_type size in bytes, for all bands
hardOutputLimit (optional)
BigDecimal maximum file size to download
compressionLevel (optional)
Integer compression level for the output zip file
maxAnimationFrames (optional)
Integer maximum number of frames allowed (if no limit, the maximum execution time limits will still apply and stop the process in case there are too many)