Web service API

How to use PageSeeder's Web service API

uris export

/members/{member}/export [GET]

com.pageseeder.export.Export

Description

Export document(s) using path or uris parameters.

This service exports the document(s) specified using the Universal Portable Format.

Note

It is also the service supporting the export Ant task. If you're working with Ant or outside a Web environment, it may be more appropriate to use the Ant task.

If there are more than 20 documents included in the export this service will start an Asynchronous process.

Parameters

NameDescriptionRequiredTypeDefault value
context Context path without the site prefix yes path URI folder
path the path of the URI to export (without the site prefix), needed if "uris" is not specified maybe path
uris Comma-separated list of URI IDs to export, needed if "path" is not specified maybe longs
compare Value of the release to compare with, if the value is a float and none match, the closest previous release is loaded no string
excludes A comma-separated list of file name patterns to exclude from the export, only used if "path" is specified and points to a folder no strings
fail-on-error Flag to specify if the first error should kill the export no boolean false
forward-depth The depth of outgoing cross-references to traverse no integer  0 
host the host of the URI to export no string see below
includes A comma-separated list of file name patterns to include in the export, only used if "path" is specified and points to a folder no strings
metadata-only Flag to specify if only metadata PSML should be included in the export no boolean false
port the port of the URI to export no port see below
release Value of the version to export, if the value is a float and none match, the closest previous release is loaded no string
resolve-images Flag to specify if referenced images should be included in the export no boolean true
reverse-depth The depth of inward cross-references to traverse no integer 0
scheme the scheme of the URI to export no string see below
since Last modified date used to filter URIs to export, only used if "path" is specified and points to a folder no date or datetime
with Comma-separated list of facets used to filter URIs to export, only used if "path" is specified and points to a folder no strings
xref-types A comma-separated list of cross-references to traverse no  strings (all types)

scheme

If specified, the scheme should be a valid scheme used in the PageSeeder hosts. Generally "http" or "https". It defaults to the webSiteScheme template property.

host

If specified, the host must be one of the define PageSeeder hosts. It defaults to the webSiteHost template property.

port

If specified the port must be a valid port number (1 through 65535) used in a PageSeeder host. It defaults to the webSitePort template property.

Permission

Undocumented permissions requirements.

Response

This service returns the following XML:

<thread ...>
  ...
  [<processing current="[number processed]" total="[total processing]"/>]
  [<packaging current="[number packaged]" total="[total packaging]"/>]
  [<zip>[zip file name]</zip>]
</thread>

When the export is complete it can be downloaded using the URL:

[scheme]://[my server]/ps/member-resource/[group name]/[zip file name]

For example:

https://example.org/ps/member-resource/example-specs/export-1449617820208.zip

Error Handling

No specific errors expected for this service.

Check the process logs for errors.

Created on , last edited on