GeoServer Importer Extension - Transforms

The Importer extension gives a GeoServer administrator an alternate, more-streamlined method for uploading and configuring new layers. The transforms endpoint manages data transforms applied to individual import jobs. The importer extension is an optional install and may not be available on all deployments of GeoServer
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

ImporterTransforms

ImporterTransforms

Up
delete /imports/{importId}/tasks/{taskId}/transforms/{transformId}
Removes the transformation (deleteTransform)
Removes the transformation identified by {transformId} inside a task with id {taskId} within import with id {importId}

Path parameters

importId (required)
Path Parameter — The ID of the import
taskId (required)
Path Parameter — The ID of the task
transformId (required)
Path Parameter — The ID of the transform

Responses

200

OK

Up
get /imports/{importId}/tasks/{taskId}/transforms/{transformId}
Retrieve a transformation (getTransform)
Retrieve a transformation identified by {transformId} inside a task with id {taskId} within import with id {importId}

Path parameters

importId (required)
Path Parameter — The ID of the import
taskId (required)
Path Parameter — The ID of the task
transformId (required)
Path Parameter — The ID of the transform

Query parameters

expand (optional)
Query Parameter — What level to expand the response object to. Can be "self" (expand only the response object and its immediate children), "all" (expand all children), "none" (don't include any children), or a nonnegative integer, indicating the depth of children to expand to. Defaults to "self" or "none", depending on the request.

Return type

Transform

Example data

Content-Type: application/json
{
  "href" : "href",
  "type" : "type"
}

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 Transform

Up
get /imports/{importId}/tasks/{taskId}/transforms
Retrieve transformation list (getTransforms)
Retrieve the list of transformations of a task with id {taskId} within import with id {importId}

Path parameters

importId (required)
Path Parameter — The ID of the import
taskId (required)
Path Parameter — The ID of the task

Query parameters

expand (optional)
Query Parameter — What level to expand the response object to. Can be "self" (expand only the response object and its immediate children), "all" (expand all children), "none" (don't include any children), or a nonnegative integer, indicating the depth of children to expand to. Defaults to "self" or "none", depending on the request.

Return type

Transforms

Example data

Content-Type: application/json
"{\n  \"transforms\": [\n    {\n      \"type\": \"ReprojectTransform\",\n      \"href\": \"http://localhost:8080/geoserver/rest/imports/0/tasks/1/transforms/0\",\n      \"source\": null,\n      \"target\": \"EPSG:4326\"\n    },\n    {\n      \"type\": \"DateFormatTransform\",\n      \"href\": \"http://localhost:8080/geoserver/rest/imports/0/tasks/1/transforms/1\",\n      \"field\": \"date\",\n      \"format\": \"yyyyMMdd\"\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 Transforms

Example data

Content-Type: application/json
{
  "transforms": [
    {
      "type": "ReprojectTransform",
      "href": "http://localhost:8080/geoserver/rest/imports/0/tasks/1/transforms/0",
      "source": null,
      "target": "EPSG:4326"
    },
    {
      "type": "DateFormatTransform",
      "href": "http://localhost:8080/geoserver/rest/imports/0/tasks/1/transforms/1",
      "field": "date",
      "format": "yyyyMMdd"
    }
  ]
}

Up
post /imports/{importId}/tasks/{taskId}/transforms
Create a new transformation (postTransform)
Create a new transformation and append it inside a task with id {taskId} within import with id {importId}

Path parameters

importId (required)
Path Parameter — The ID of the import
taskId (required)
Path Parameter — The ID of the task

Consumes

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

Request body

transformBody Transform (required)
Body Parameter — The transform to add.

Query parameters

expand (optional)
Query Parameter — What level to expand the response object to. Can be "self" (expand only the response object and its immediate children), "all" (expand all children), "none" (don't include any children), or a nonnegative integer, indicating the depth of children to expand to. Defaults to "self" or "none", depending on the request.

Responses

201

Created

Up
put /imports/{importId}/tasks/{taskId}/transforms/{transformId}
Modifies a transformation (putTransform)
Modifies the definition of a transformation identified by {transformId} inside a task with id {taskId} within import with id {importId}

Path parameters

importId (required)
Path Parameter — The ID of the import
taskId (required)
Path Parameter — The ID of the task
transformId (required)
Path Parameter — The ID of the transform

Consumes

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

Request body

transformBody Transform (required)
Body Parameter — The transform to add.

Query parameters

expand (optional)
Query Parameter — What level to expand the response object to. Can be "self" (expand only the response object and its immediate children), "all" (expand all children), "none" (don't include any children), or a nonnegative integer, indicating the depth of children to expand to. Defaults to "self" or "none", depending on the request.

Return type

Transform

Example data

Content-Type: application/json
{
  "href" : "href",
  "type" : "type"
}

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 Transform

Models

[ Jump to Methods ]

Table of Contents

  1. Transform - transform
  2. Transforms - transforms

Transform - transform Up

A data transform applied to the import data.
type (optional)
String The name of the transform
href (optional)
String URL to the transform endpoint

Transforms - transforms Up

A list of transforms