GeoServer Parameter Extractor

A parameter extractor rule allows specific request parameters as URL path fragments instead of using the query string. A echo parameter makes sure that certain URL paratemers are added to the capabilities documents backlinks.
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

Default

Default

Up
delete /params-extractor/echoes/{parameterId}
Delete an echo parameter (deleteEchoParameter)
Deletes an echo parameter from the configuration

Path parameters

parameterId (required)
Path Parameter — The identifier of the echo parameter to retrieve.

Responses

200

OK

Up
delete /params-extractor/rules/{ruleId}
Delete a rule (deleteRule)
Deletes a rule from the configuration

Path parameters

ruleId (required)
Path Parameter — The identifier of the rule to retrieve.

Responses

200

OK

Up
get /params-extractor/echoes/{parameterId}
Retrieve a particular echo parameter definition (getEchoParameter)
Controls a particular echo parameter. Use the "Accept:" header to specify format or append an extension to the endpoint (example "/echos/{parameterId}.xml" for XML).

Path parameters

parameterId (required)
Path Parameter — The identifier of the echo parameter to retrieve.

Return type

EchoParameter

Example data

Content-Type: application/xml
"\n"

Example data

Content-Type: application/json
"{\"EchoParameter\": {\n  \"id\": 0,\n  \"parameter\": \"CQL_FILTER\",\n  \"activated\": 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 EchoParameter

Example data

Content-Type: application/xml

Example data

Content-Type: application/json
{"EchoParameter": {
  "id": 0,
  "parameter": "CQL_FILTER",
  "activated": true
}}

Up
get /params-extractor/echoes
Get a list of echo parameters (getEchoParameters)
List all echo parameters currently configured. Use the "Accept:" header to specify format or append an extension to the endpoint (example "/datastores.xml" for XML)

Return type

EchoParameters

Example data

Content-Type: application/xml
"\n  \n    0\n    \n  \n\n"

Example data

Content-Type: application/json
"{\"EchoParameters\": {\"EchoParameter\": [\n    {\n    \"id\": 0,\n    \"href\": \"http://localhost:8080/geoserver/rest/params-extractor/echoes/0.json\"\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 EchoParameters

Example data

Content-Type: application/xml

  
    0
    
  

Example data

Content-Type: application/json
{"EchoParameters": {"EchoParameter": [
    {
    "id": 0,
    "href": "http://localhost:8080/geoserver/rest/params-extractor/echoes/0.json"
  }
]}}

Up
get /params-extractor/rules/{ruleId}
Retrieve a particular rule definition (getRule)
Controls a particular rule . Use the "Accept:" header to specify format or append an extension to the endpoint (example "/echos/{parameterId}.xml" for XML).

Path parameters

ruleId (required)
Path Parameter — The identifier of the rule to retrieve.

Return type

Rule

Example data

Content-Type: application/xml
"\n"

Example data

Content-Type: application/json
"{\"Rule\": {\n  \"id\": 0,\n  \"activated\": true,\n  \"position\": 3,\n  \"parameter\": \"cql_filter\",\n  \"transform\": \"seq='$2'\",\n  \"remove\": 1\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 Rule

Example data

Content-Type: application/xml

Example data

Content-Type: application/json
{"Rule": {
  "id": 0,
  "activated": true,
  "position": 3,
  "parameter": "cql_filter",
  "transform": "seq='$2'",
  "remove": 1
}}

Up
get /params-extractor/rules
Get a list of rules (getRules)
List all rules currently configured. Use the "Accept:" header to specify format or append an extension to the endpoint (example "/datastores.xml" for XML)

Return type

Rules

Example data

Content-Type: application/xml
"\n  \n    0\n    \n  \n\n"

Example data

Content-Type: application/json
"{\"Rules\": {\"Rule\": [\n  {\n    \"id\": 0,\n    \"href\": \"http://localhost:8080/geoserver/rest/params-extractor/rules/0.json\"\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 Rules

Example data

Content-Type: application/xml

  
    0
    
  

Example data

Content-Type: application/json
{"Rules": {"Rule": [
  {
    "id": 0,
    "href": "http://localhost:8080/geoserver/rest/params-extractor/rules/0.json"
  }
]}}

Up
post /params-extractor/echoes
Create a new echo parameter (postEchoParameter)
Adds a new echo parameter

Consumes

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

Request body

body EchoParameter (optional)
Body Parameter

Return type

String

Example data

Content-Type: application/json
""

Responses

201

Created String

Up
post /params-extractor/rules
Create a new rule (postRule)
Adds a new rule

Consumes

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

Request body

body Rule (optional)
Body Parameter

Return type

String

Example data

Content-Type: application/json
""

Responses

201

Created String

Up
put /params-extractor/echoes/{parameterId}
Modify an echo parametr (putEchoParameter)
Modify an echo parameter

Path parameters

parameterId (required)
Path Parameter — The identifier of the echo parameter to retrieve.

Consumes

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

Request body

body EchoParameter (optional)
Body Parameter

Responses

200

The echo parameter was successfully updated.

Up
put /params-extractor/rules/{ruleId}
Modify a rule (putRule)
Modify a rule

Path parameters

ruleId (required)
Path Parameter — The identifier of the echo parameter to retrieve.

Consumes

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

Request body

body Rule (optional)
Body Parameter

Responses

200

The rule was successfully updated.

Models

[ Jump to Methods ]

Table of Contents

  1. EchoParameter - EchoParameter
  2. EchoParameters - Echo parameter links list
  3. Rule - Rule
  4. Rules - Rule link list
  5. echoParameterListItem -
  6. ruleListItem -

EchoParameter - EchoParameter Up

id (optional)
String identifier of the echo parameter
parameter (optional)
String The parameter name
activated (optional)
Boolean Whether or not the parameter echoing is active

EchoParameters - Echo parameter links list Up

Rule - Rule Up

id (optional)
String identifier of the rule
activated (optional)
Boolean Whether or not the parameter echoing is active
position (optional)
Integer The position of the URL base path element to be selected
parameter (optional)
String The name of the parameter produced by this rule
transform (optional)
String Expression that defines the value of the parameter, use {PARAMETER} as a placeholder for the selected path element
match (optional)
String Regex match expression with groups, for example ^(?:/[^/]){3}(/([^/]+)).$ selects the URL base path third element
activation (optional)
String If defined this rule will only be applied to URLs that match this regex expression
remove (optional)
Integer The match expression group to be removed from URL, by default 1
combine (optional)
String Defines how to combine parameter existing value ($1 existing value, $2 new value), by default the value is overridden

Rules - Rule link list Up

echoParameterListItem - Up

id (optional)
String Identifeir of the echo paameter
link (optional)
String URL to the echo parameter definition

ruleListItem - Up

id (optional)
String Identifeir of the rule
link (optional)
String URL to the rule definition