Web service API

How to use PageSeeder's Web service API

uri group export

/members/{member}/groups/{group}/uris/{uri}/export [GET]

com.pageseeder.export.Export

Description

Start export

Export the document(s) specified.

The output is always the XML representation of a Process Thread. Once the thread is completed, the XML will contain a element which contains the file name of the ZIP file containing the contents of the export. Use the com.pageseeder.resource.MemberResourceServlet  to retrieve it.

Parameters

NameDescriptionRequiredTypeDefault value
context Context of the upload (without the site prefix), required if "uris" is specified maybe string
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 Comma-separated list of file name patterns to exclude from the export, only used if "path" is specified and points to a folder no string
fail-on-error Flag to specify if the first error should kill the export no boolean true
forward-depth the depth of outgoing cross-references to traverse no integer 0
image-metadata-only Flag to specify if only metadata of referenced images should be included in the export no boolean false
includes Comma-separated list of file name patterns to include in the export, only used if "path" is specified and points to a folder no string
load-alternates Flag to specify if alternate XRefs should be included in the export no boolean false
load-images Flag to specify if referenced images should be included in the export no boolean true
metadata-only Flag to specify if only metadata PSML should be included in the export no boolean false
release Value of the release to export, if the value is a float and none match, the closest previous release is loaded no string
resolve-images no string
reverse-depth the depth of outgoing cross-references to traverse no integer 0
since Last modified date used to filter URIs to export, only used if "path" is specified and points to a folder no string
with Comma-separated list of facets used to filter URIs to export, only used if "path" is specified and points to a folder no string
without not used no string
xref-types Comma-separated list of cross-references to traverse (none,embed,transclude) no string

Permission

Undocumented permissions requirements.

Response

Undocumented XML response

Error handling

No specific errors expected for this generator.

Created on , last edited on