.. WPS Request Parameters #----------------------------------------------------------------------------- # # Project: EOxServer # Authors: Fabian Schindler # #----------------------------------------------------------------------------- # Copyright (C) 2020 EOX IT Services GmbH # # Permission is hereby granted, free of charge, to any person obtaining a # copy of this software and associated documentation files (the "Software"), # to deal in the Software without restriction, including without limitation # the rights to use, copy, modify, merge, publish, distribute, sublicense, # and/or sell copies of the Software, and to permit persons to whom the # Software is furnished to do so, subject to the following conditions: # # The above copyright notice and this permission notice shall be included in # all copies of this Software or works derived from this Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER # DEALINGS IN THE SOFTWARE. #----------------------------------------------------------------------------- .. _wps: Web Processing Service (WPS) ============================ The OpenGIS® Web Processing Service (WPS) Interface Standard provides rules for standardizing how inputs and outputs (requests and responses) for geospatial processing services, such as polygon overlay. The standard also defines how a client can request the execution of a process, and how the output from the process is handled. It defines an interface that facilitates the publishing of geospatial processes and clients’ discovery of and binding to those processes. The data required by the WPS can be delivered across a network or they can be available at the server. The standard can be obtained from the `Open Geospatial Consortiums homepage `_. The following tables provide an overview over the available WPS request parameters for each operation supported by EOxServer. .. index:: single: GetCapabilities (WPS Request Parameters) GetCapabilities --------------- Table: ":ref:`table_wps_request_parameters_getcapabilities`" below lists all parameters that are available with Capabilities requests. .. _table_wps_request_parameters_getcapabilities: .. table:: WPS GetCapabilities Request Parameters +---------------------------+-----------------------------------------------------------+----------------------------------+--------------------------------+ | Parameter | Description / Subparameter | Allowed value(s) / Example | Mandatory (M) / Optional (O) | +===========================+===========================================================+==================================+================================+ | service | Requested service | WPS | M | +---------------------------+-----------------------------------------------------------+----------------------------------+--------------------------------+ | request | Type of request | GetCapabilities | M | +---------------------------+-----------------------------------------------------------+----------------------------------+--------------------------------+ | acceptVersions [1]_ | Prioritized sequence of one or more specification | 1.0.0 | O | | | versions accepted by the client, with preferred versions | | | | | listed first (first supported version will be used) | | | | | version1[,version2[,...]] | | | +---------------------------+-----------------------------------------------------------+----------------------------------+--------------------------------+ | updateSequence | Date of last issued GetCapabilities request; to receive | "2013-05-08" | O | | | new document only if it has changed since | | | +---------------------------+-----------------------------------------------------------+----------------------------------+--------------------------------+ .. index:: single: DescribeProcess (WPS Request Parameters) DescribeProcess --------------- Table: ":ref:`table_wps_request_parameters_describeprocess`" below lists all parameters that are available with GetCoverage requests. .. _table_wps_request_parameters_describeprocess: .. table:: WPS DescribeProcess Request Parameters +---------------------------+-----------------------------------------------------------+----------------------------------+--------------------------------+ | Parameter | Description / Subparameter | Allowed value(s) / Example | Mandatory (M) / Optional (O) | +===========================+===========================================================+==================================+================================+ | service | Requested service | WPS | M | +---------------------------+-----------------------------------------------------------+----------------------------------+--------------------------------+ | request | Type of request | DescribeProcess | M | +---------------------------+-----------------------------------------------------------+----------------------------------+--------------------------------+ | version | Version number | 1.0.0 | M | +---------------------------+-----------------------------------------------------------+----------------------------------+--------------------------------+ | identifier | The process identifier to get a detailed description for. | | M | | | It is possible to get multiple descriptions by passing a | | | | | comma separated list of process identifiers. | | | | | | | | | | The process identifiers can be obtained from the | | | | | GetCapabilities document. | | | +---------------------------+-----------------------------------------------------------+----------------------------------+--------------------------------+ Execute ------- Table: ":ref:`table_wps_request_parameters_execute`" below lists all parameters that are available with GetCoverage requests. .. _table_wps_request_parameters_execute: .. table:: WPS Execute Request Parameters +---------------------------+-----------------------------------------------------------+----------------------------------+--------------------------------+ | Parameter | Description / Subparameter | Allowed value(s) / Example | Mandatory (M) / Optional (O) | +===========================+===========================================================+==================================+================================+ | service | Requested service | WPS | M | +---------------------------+-----------------------------------------------------------+----------------------------------+--------------------------------+ | request | Type of request | Execute | M | +---------------------------+-----------------------------------------------------------+----------------------------------+--------------------------------+ | version | Version number | 1.0.0 | M | +---------------------------+-----------------------------------------------------------+----------------------------------+--------------------------------+ | identifier | The process to execute. | | M | +---------------------------+-----------------------------------------------------------+----------------------------------+--------------------------------+ | DataInputs | A key-value mapping of data inputs. For each input, the | input1=abc@uom:a | M | | | unit of measure (UOM) | | | +---------------------------+-----------------------------------------------------------+----------------------------------+--------------------------------+ | ResponseDocument | This parameter selects the outputs of interest, their | output1=abc@uom:a | O | | | format and unit of measure (UOM). | | | +---------------------------+-----------------------------------------------------------+----------------------------------+--------------------------------+ | RawDataOutput | Selects a single output that shall be returned as a raw | input1=abc@uom:a | O | | | data item. Mutually exclusive with ``ResponseDocument``. | | | +---------------------------+-----------------------------------------------------------+----------------------------------+--------------------------------+ | status | Boolean value whether to include a data lineag in the | | O | | | response document. | | | +---------------------------+-----------------------------------------------------------+----------------------------------+--------------------------------+ | lineage | Boolean value whether to include a data lineag in the | | M | | | response document. | | | +---------------------------+-----------------------------------------------------------+----------------------------------+--------------------------------+ | storeExecuteResponse | Boolean value whether to store the result on the server. | | O | +---------------------------+-----------------------------------------------------------+----------------------------------+--------------------------------+ .. TODO: better description and examples .. [1] For WMS service version 1.3 the ``crs`` parameter must be used, for services versions below 1.3 the parameter name is ``srs``.