GeoServer Template
Manage templates used to configure output (for example GetFeatureInfo reponse). Templates can be registered for the entire server or workspace. You can also configure a template for use with a store, featureType or coverage.
Version: 1.0.0
BasePath:/geoserver/rest
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
[ Jump to Models ]
Table of Contents
Up
delete /workspaces/{workspace}/coveragestore/{store}/coverages/{coverage}/templates/{template}.ftl
Delete a template. (templateCoverageDelete)
Deletes a single template registered for use by a coverage.
Path parameters
workspace (required)
Path Parameter — The workspace name
store (required)
Path Parameter — The store name
coverage (required)
Path Parameter — The coverage name
template (required)
Path Parameter — The template name
Responses
200
OK
404
Template not found
Up
get /workspaces/{workspace}/coveragestore/{store}/coverages/{coverage}/templates/{template}.ftl
Return a template for a coverage (templateCoverageGet)
Displays a single template registered for use by a coverage (example for GetFeatureInfo WMS operation).
Path parameters
workspace (required)
Path Parameter — The workspace name
store (required)
Path Parameter — The store name
coverage (required)
Path Parameter — The coverage name
template (required)
Path Parameter — The template name
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
Templates
Up
post /workspaces/{workspace}/coveragestore/{store}/coverages/{coverage}/templates/{template}.ftl
(templateCoveragePost)
Invalid. Use PUT to insert a template.
Path parameters
workspace (required)
Path Parameter — The workspace name
store (required)
Path Parameter — The store name
coverage (required)
Path Parameter — The coverage name
template (required)
Path Parameter — The template name
Responses
405
Method Not Allowed
Up
put /workspaces/{workspace}/coveragestore/{store}/coverages/{coverage}/templates/{template}.ftl
Insert or update a template (templateCoveragePut)
Inserts or updates a single template registered for use by a coverage (example for GetFeatureInfo WMS operation). Overwrites any existing template with the same name and location.
Path parameters
workspace (required)
Path Parameter — The workspace name
store (required)
Path Parameter — The store name
coverage (required)
Path Parameter — The coverage name
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The template content to upload
Responses
201
Created
Up
delete /workspaces/{workspace}/coveragestore/{store}/templates/{template}.ftl
Delete a template. (templateDataStoreCSDelete)
Deletes a single template registered for use by all layers generated by a coverage store.
Path parameters
workspace (required)
Path Parameter — The workspace name
store (required)
Path Parameter — The store name
template (required)
Path Parameter — The template name
Responses
200
OK
404
Template not found
Up
get /workspaces/{workspace}/coveragestore/{store}/templates/{template}.ftl
Return a template for a coverage store (templateDataStoreCSGet)
Displays a single template registered for use by all layers generated by a coverage store (example for GetFeatureInfo WMS operation).
Path parameters
workspace (required)
Path Parameter — The workspace name
store (required)
Path Parameter — The store name
template (required)
Path Parameter — The template name
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
Templates
Up
post /workspaces/{workspace}/coveragestore/{store}/templates/{template}.ftl
(templateDataStoreCSPost)
Invalid. Use PUT to insert a template.
Path parameters
workspace (required)
Path Parameter — The workspace name
store (required)
Path Parameter — The store name
template (required)
Path Parameter — The template name
Responses
405
Method Not Allowed
Up
put /workspaces/{workspace}/coveragestore/{store}/templates/{template}.ftl
Insert or update a template (templateDataStoreCSPut)
Inserts or updates a single template registered for use by all layers generated by a coverage store (example for GetFeatureInfo WMS operation). Overwrites any existing template with the same name and location.
Path parameters
workspace (required)
Path Parameter — The workspace name
store (required)
Path Parameter — The store name
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The template content to upload
Responses
201
Created
Up
delete /workspaces/{workspace}/datastores/{store}/templates/{template}.ftl
Delete a template. (templateDataStoreDelete)
Deletes a single template registered for use by all layers generated by a data store.
Path parameters
workspace (required)
Path Parameter — The workspace name
store (required)
Path Parameter — The store name
template (required)
Path Parameter — The template name
Responses
200
OK
404
Template not found
Up
delete /workspaces/{workspace}/datastores/{store}/featuretypes/{type}/templates/{template}.ftl
Delete a template. (templateDataStoreFTDelete)
Deletes a single template registered for use by a feature type.
Path parameters
workspace (required)
Path Parameter — The workspace name
store (required)
Path Parameter — The store name
type (required)
Path Parameter — The feature type name
template (required)
Path Parameter — The template name
Responses
200
OK
404
Template not found
Up
get /workspaces/{workspace}/datastores/{store}/featuretypes/{type}/templates/{template}.ftl
Return a template for a feature type. (templateDataStoreFTGet)
Displays a single template registered for use by a feature type (example for GetFeatureInfo WMS operation).
Path parameters
workspace (required)
Path Parameter — The workspace name
store (required)
Path Parameter — The store name
type (required)
Path Parameter — The feature type name
template (required)
Path Parameter — The template name
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
Templates
Up
post /workspaces/{workspace}/datastores/{store}/featuretypes/{type}/templates/{template}.ftl
(templateDataStoreFTPost*)
Invalid. Use PUT to insert a template.
Path parameters
workspace (required)
Path Parameter — The workspace name
store (required)
Path Parameter — The store name
type (required)
Path Parameter — The feature type name
template (required)
Path Parameter — The template name
Responses
405
Method Not Allowed
Up
put /workspaces/{workspace}/datastores/{store}/featuretypes/{type}/templates/{template}.ftl
Insert or update a template (templateDataStoreFTPut)
Inserts or updates a single template registered for use by a feature type (example for GetFeatureInfo WMS operation). Overwrites any existing template with the same name and location.
Path parameters
workspace (required)
Path Parameter — The workspace name
store (required)
Path Parameter — The store name
type (required)
Path Parameter — The feature type name
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The template content to upload
Responses
201
Created
Up
get /workspaces/{workspace}/datastores/{store}/templates/{template}.ftl
Return a template for a data store (templateDataStoreGet)
Displays a single template registered for use by all layers generated by a data store (example for GetFeatureInfo WMS operation).
Path parameters
workspace (required)
Path Parameter — The workspace name
store (required)
Path Parameter — The store name
template (required)
Path Parameter — The template name
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
Templates
Up
post /workspaces/{workspace}/datastores/{store}/templates/{template}.ftl
(templateDataStorePost)
Invalid. Use PUT to insert a template.
Path parameters
workspace (required)
Path Parameter — The workspace name
store (required)
Path Parameter — The store name
template (required)
Path Parameter — The template name
Responses
405
Method Not Allowed
Up
put /workspaces/{workspace}/datastores/{store}/templates/{template}.ftl
Insert or update a template (templateDataStorePut)
Inserts or updates a single template registered for use by all layers generated by a data store (example for GetFeatureInfo WMS operation). Overwrites any existing template with the same name and location.
Path parameters
workspace (required)
Path Parameter — The workspace name
store (required)
Path Parameter — The store name
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The template content to upload
Responses
201
Created
Up
delete /templates/{template}.ftl
Delete a template. (templateDelete)
Deletes a single template registered for use on the server.
Path parameters
template (required)
Path Parameter — The template name
Responses
200
OK
404
Template not found
Up
get /templates/{template}.ftl
Return a template (templateGet)
Displays a single template registered for use on the server.
Path parameters
template (required)
Path Parameter — The template name
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
Templates
Up
post /templates/{template}.ftl
(templatePost)
Invalid. Use PUT to insert a template.
Path parameters
template (required)
Path Parameter — The template name
Responses
405
Method Not Allowed
Up
put /templates/{template}.ftl
Insert or update a template (templatePut)
Inserts or updates a single template registered for use on the server. Overwrites any existing template with the same name and location.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The template content to upload
Responses
201
Created
Up
delete /workspaces/{workspace}/templates/{template}.ftl
Delete a template. (templateWorkspaceDelete)
Deletes a single template registered for use in a workspace.
Path parameters
workspace (required)
Path Parameter — The workspace name
template (required)
Path Parameter — The template name
Responses
200
OK
404
Template not found
Up
get /workspaces/{workspace}/templates/{template}.ftl
Return a template for workspace (templateWorkspaceGet)
Displays a single template registered for use in a workspace (example for GetFeatureInfo WMS operation).
Path parameters
workspace (required)
Path Parameter — The workspace name
template (required)
Path Parameter — The template name
Return type
Example data
Content-Type:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
Templates
Up
post /workspaces/{workspace}/templates/{template}.ftl
(templateWorkspacePost)
Invalid. Use PUT to insert a template.
Path parameters
workspace (required)
Path Parameter — The workspace name
template (required)
Path Parameter — The template name
Responses
405
Method Not Allowed
Up
put /workspaces/{workspace}/templates/{template}.ftl
Insert or update a template (templateWorkspacePut)
Inserts or updates a single template registered for use in a workspace (example for GetFeatureInfo WMS operation). Overwrites any existing template with the same name and location.
Path parameters
workspace (required)
Path Parameter — The workspace name
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The template content to upload
Responses
201
Created
Up
delete /workspaces/{workspace}/coveragestore/{store}/coverages/{coverage}/templates
(templatesCoverageDelete)
Invalid. Delete from /{template}
to remove a template.
Path parameters
workspace (required)
Path Parameter — The workspace name
store (required)
Path Parameter — The store name
coverage (required)
Path Parameter — The coverage name
Responses
405
Method Not Allowed
Up
get /workspaces/{workspace}/coveragestore/{store}/coverages/{coverage}/templates
List of templates for a coverage (templatesCoverageGet)
Displays a list of templates registered for use by a coverage (example for GetFeatureInfo WMS operation).
Path parameters
workspace (required)
Path Parameter — The workspace name
store (required)
Path Parameter — The store name
coverage (required)
Path Parameter — The coverage name
Return type
Example data
Content-Type: application/xml
Example data
Content-Type: application/json
{
"layerGroups" : "{}"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/html
application/xml
application/json
Responses
200
OK
Templates
Up
post /workspaces/{workspace}/coveragestore/{store}/coverages/{coverage}/templates
(templatesCoveragePost)
Invalid. PUT to /{template}
to edit a template.
Path parameters
workspace (required)
Path Parameter — The workspace name
store (required)
Path Parameter — The store name
coverage (required)
Path Parameter — The coverage name
Responses
405
Method Not Allowed
Up
put /workspaces/{workspace}/coveragestore/{store}/coverages/{coverage}/templates
(templatesCoveragePut)
Invalid. PUT to /{template}
to edit a template.
Path parameters
workspace (required)
Path Parameter — The workspace name
store (required)
Path Parameter — The store name
coverage (required)
Path Parameter — The coverage name
Responses
405
Method Not Allowed
Up
delete /workspaces/{workspace}/coveragestore/{store}/templates
(templatesDataStoreCSDelete)
Invalid. Delete from /{template}
to remove a template.
Path parameters
workspace (required)
Path Parameter — The workspace name
store (required)
Path Parameter — The store name
Responses
405
Method Not Allowed
Up
get /workspaces/{workspace}/coveragestore/{store}/templates
List of templates for a coverage store (templatesDataStoreCSGet)
Displays a list of templates registered for use by all layers generated by a coverage store (example for GetFeatureInfo WMS operation).
Path parameters
workspace (required)
Path Parameter — The workspace name
store (required)
Path Parameter — The store name
Return type
Example data
Content-Type: application/xml
Example data
Content-Type: application/json
{
"layerGroups" : "{}"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/html
application/xml
application/json
Responses
200
OK
Templates
Up
post /workspaces/{workspace}/coveragestore/{store}/templates
(templatesDataStoreCSPost)
Invalid. PUT to /{template}
to edit a template.
Path parameters
workspace (required)
Path Parameter — The workspace name
store (required)
Path Parameter — The store name
Responses
405
Method Not Allowed
Up
put /workspaces/{workspace}/coveragestore/{store}/templates
(templatesDataStoreCSPut)
Invalid. PUT to /{template}
to edit a template.
Path parameters
workspace (required)
Path Parameter — The workspace name
store (required)
Path Parameter — The store name
Responses
405
Method Not Allowed
Up
delete /workspaces/{workspace}/datastores/{store}/templates
(templatesDataStoreDelete)
Invalid. Delete from /{template}
to remove a template.
Path parameters
workspace (required)
Path Parameter — The workspace name
store (required)
Path Parameter — The store name
Responses
405
Method Not Allowed
Up
delete /workspaces/{workspace}/datastores/{store}/featuretypes/{type}/templates
(templatesDataStoreFTDelete)
Invalid. Delete from /{template}
to remove a template.
Path parameters
workspace (required)
Path Parameter — The workspace name
store (required)
Path Parameter — The store name
type (required)
Path Parameter — The feature type name
Responses
405
Method Not Allowed
Up
get /workspaces/{workspace}/datastores/{store}/featuretypes/{type}/templates
List of templates for a feature type. (templatesDataStoreFTGet)
Displays a list of templates registered for use by feature type (example for GetFeatureInfo WMS operation).
Path parameters
workspace (required)
Path Parameter — The workspace name
store (required)
Path Parameter — The store name
type (required)
Path Parameter — The feature type name
Return type
Example data
Content-Type: application/xml
Example data
Content-Type: application/json
{
"layerGroups" : "{}"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/html
application/xml
application/json
Responses
200
OK
Templates
Up
post /workspaces/{workspace}/datastores/{store}/featuretypes/{type}/templates
(templatesDataStoreFTPost)
Invalid. PUT to /{template}
to edit a template.
Path parameters
workspace (required)
Path Parameter — The workspace name
store (required)
Path Parameter — The store name
type (required)
Path Parameter — The feature type name
Responses
405
Method Not Allowed
Up
put /workspaces/{workspace}/datastores/{store}/featuretypes/{type}/templates
(templatesDataStoreFTPut)
Invalid. PUT to /{template}
to edit a template.
Path parameters
workspace (required)
Path Parameter — The workspace name
store (required)
Path Parameter — The store name
type (required)
Path Parameter — The feature type name
Responses
405
Method Not Allowed
Up
get /workspaces/{workspace}/datastores/{store}/templates
List of templates for a data store (templatesDataStoreGet)
Displays a list of templates registered for use by all layers generated by a data store (example for GetFeatureInfo WMS operation).
Path parameters
workspace (required)
Path Parameter — The workspace name
store (required)
Path Parameter — The store name
Return type
Example data
Content-Type: application/xml
Example data
Content-Type: application/json
{
"layerGroups" : "{}"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/html
application/xml
application/json
Responses
200
OK
Templates
Up
post /workspaces/{workspace}/datastores/{store}/templates
(templatesDataStorePost)
Invalid. PUT to /{template}
to edit a template.
Path parameters
workspace (required)
Path Parameter — The workspace name
store (required)
Path Parameter — The store name
Responses
405
Method Not Allowed
Up
put /workspaces/{workspace}/datastores/{store}/templates
(templatesDataStorePut)
Invalid. PUT to /{template}
to edit a template.
Path parameters
workspace (required)
Path Parameter — The workspace name
store (required)
Path Parameter — The store name
Responses
405
Method Not Allowed
(templatesDelete)
Invalid. Delete from /{template}
to remove a template.
Responses
405
Method Not Allowed
List of templates for the server (templatesGet)
Displays a list of templates registered for use on the server.
Return type
Example data
Content-Type: application/xml
Example data
Content-Type: application/json
{
"layerGroups" : "{}"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/html
application/xml
application/json
Responses
200
OK
Templates
(templatesPost)
Invalid. PUT to /{template}
to edit a template.
Responses
405
Method Not Allowed
(templatesPut)
Invalid. PUT to /{template}
to edit a template.
Responses
405
Method Not Allowed
Up
delete /workspaces/{workspace}/templates
(templatesWorkspaceDelete)
Invalid. Delete from /{template}
to remove a template.
Path parameters
workspace (required)
Path Parameter — The workspace name
Responses
405
Method Not Allowed
Up
get /workspaces/{workspace}/templates
List of templates for workspace (templatesWorkspaceGet)
Displays a list of templates registered for use in a workspace (example for GetFeatureInfo WMS operation).
Path parameters
workspace (required)
Path Parameter — The workspace name
Return type
Example data
Content-Type: application/xml
Example data
Content-Type: application/json
{
"layerGroups" : "{}"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/html
application/xml
application/json
Responses
200
OK
Templates
Up
post /workspaces/{workspace}/templates
(templatesWorkspacePost)
Invalid. PUT to /{template}
to edit a template.
Path parameters
workspace (required)
Path Parameter — The workspace name
Responses
405
Method Not Allowed
Up
put /workspaces/{workspace}/templates
(templatesWorkspacePut)
Invalid. PUT to /{template}
to edit a template.
Path parameters
workspace (required)
Path Parameter — The workspace name
Responses
405
Method Not Allowed
[ Jump to Methods ]
Table of Contents
TemplateReference
- layers
Templates
- templates
name (optional)
link (optional)
String URL to template definition