GeoServer Importer Extension - Data

The Importer extension gives a GeoServer administrator an alternate, more-streamlined method for uploading and configuring new layers. The data endpoint controls uploading layer data to specific 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

ImporterData

ImporterData

Up
delete /imports/{importId}/data/files/{filename}
Remove a specific file with id {filename} from the import with id {importId}. Only applies to file/directory imports. (deleteImportDataFile)

Responses

204

No Content

Up
delete /imports/{importId}/tasks/{taskId}/data/files/{filename}
Remove a specific file with id {filename} from the task with id {taskId} within import with id {importId}. Only applies to file/directory imports. (deleteTaskDataFile)

Responses

204

No Content

Up
get /imports/{importId}/data
Retrieve the database connection parameters for an import with id {importId}. Only applies to database imports. (getData)
Get import data

Path parameters

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

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. default: self

Return type

Database

Example data

Content-Type: application/json
{
  "tables" : [ {
    "name" : "name",
    "format" : "format",
    "href" : "href",
    "type" : "type"
  }, {
    "name" : "name",
    "format" : "format",
    "href" : "href",
    "type" : "type"
  } ],
  "format" : "format",
  "href" : "href",
  "type" : "type",
  "properties" : "{}"
}

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 Database

Up
get /imports/{importId}/data/files/{filename}
Retrieve information about the file with id {fileId} from the data of an import with id {importId}. Only applies to file/directory imports. (getDataFile)

Path parameters

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

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. default: self

Return type

File

Example data

Content-Type: application/json
{
  "charset" : "charset",
  "other" : [ "other", "other" ],
  "file" : "file",
  "format" : "format",
  "prj" : "prj",
  "location" : "location",
  "href" : "href",
  "type" : "type",
  "message" : { }
}

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 File

Up
get /imports/{importId}/data/files
Retrieve the list of files for an import with id {importId}. Only applies to file/directory imports. (getDataFiles)

Path parameters

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

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. default: self

Return type

Directory

Example data

Content-Type: application/json
{
  "charset" : "charset",
  "files" : "",
  "location" : "location",
  "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 Directory

Up
get /imports/{importId}/tasks/{taskId}/data
Retrieve the table description for a task with id {taskId} within import with id {importId}. Only applies to database imports. (getTaskData)

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. default: self

Return type

Table

Example data

Content-Type: application/json
{
  "name" : "name",
  "format" : "format",
  "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 Table

Up
get /imports/{importId}/tasks/{taskId}/data/files/{filename}
Retrieve information about the file with id {fileId} from the data of a task with id {taskId} within import with id {importId}. Only applies to file/directory imports. (getTaskDataFile)

Path parameters

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

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. default: self

Return type

File

Example data

Content-Type: application/json
{
  "charset" : "charset",
  "other" : [ "other", "other" ],
  "file" : "file",
  "format" : "format",
  "prj" : "prj",
  "location" : "location",
  "href" : "href",
  "type" : "type",
  "message" : { }
}

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 File

Up
get /imports/{importId}/tasks/{taskId}/data/files
Retrieve the list of files for a task with id {taskId} within import with id {importId}. Only applies to file/directory imports. (getTaskDataFiles)

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. default: self

Return type

Directory

Example data

Content-Type: application/json
{
  "charset" : "charset",
  "files" : "",
  "location" : "location",
  "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 Directory

Models

[ Jump to Methods ]

Table of Contents

  1. Database - database
  2. Directory - directory
  3. File - file
  4. FileContents - filecontents
  5. Files - files
  6. Message - message
  7. Table - table

Database - database Up

An import data object representing a database
type (optional)
String "database"
format (optional)
href (optional)
String URL to the database endpoint
properties (optional)
Object Database connection parameters. Actual paramaters vary depending on the type of database.
tables (optional)

Directory - directory Up

An import data object representing a directory of spatial files or an image mosaic
type (optional)
String "directory" or "mosaic"
location (optional)
String Absolute system path to the directory
href (optional)
String URL to the directory endpoint
charset (optional)
String Charset encoding of the data
files (optional)

File - file Up

An import data object representing a spatial file or granule
type (optional)
String "file"
format (optional)
String Format of the file
href (optional)
String URL to the file endpoint
location (optional)
String Absolute system path to the file
charset (optional)
String The charset encoding of the data
file (optional)
String Name of the file
prj (optional)
String Name of the .prj file, if applicable
other (optional)
array[String] List of other files that comprise this spatial file.
message (optional)

FileContents - filecontents Up

Description of a spatial file or granule
file (optional)
String Name of the file
href (optional)
String URL to the file endpoint
prj (optional)
String Name of the .prj file, if applicable
other (optional)
array[String] List of other files that comprise this spatial file.

Files - files Up

List of file descriptors

Message - message Up

A message about the import data.

Table - table Up

An import data object representing a a database table
type (optional)
String "table"
name (optional)
format (optional)
href (optional)
String URL to the table endpoint