Web service API

How to use PageSeeder's Web service API

uris group export

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

com.pageseeder.export.Export

Description

Start export for multiple uris or uri using path.

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
contextContext of the upload (without the site prefix), required if "uris" is specifiedmaybestring
paththe path of the URI to export (without the site prefix), required if "uris" is not specifiedmaybestring
urisComma-separated list of URI IDs to export, required if "path" is not specifiedmaybestring
compareValue of the release to compare with, if the value is a float and none match, the closest previous release is loadednostring
excludesComma-separated list of file name patterns to exclude from the export, only used if "path" is specified and points to a foldernostring
fail-on-errorFlag to specify if the first error should kill the exportnobooleantrue
forward-depththe depth of outgoing cross-references to traversenointeger0
hostthe host of the URI to export nostringwebSiteAddress template property
image-metadata-onlyFlag to specify if only metadata of referenced images should be included in the exportnobooleanfalse
includesComma-separated list of file name patterns to include in the export, only used if "path" is specified and points to a foldernostring
load-alternatesFlag to specify if alternate XRefs should be included in the exportnobooleanfalse
load-imagesFlag to specify if referenced images should be included in the exportnobooleantrue
metadata-onlyFlag to specify if only metadata PSML should be included in the exportnobooleanfalse
portthe port of the URI to exportnointegerdocumentPort template property
releaseValue of the release to export, if the value is a float and none match, the closest previous release is loadednostring
resolve-imagesnostring
reverse-depththe depth of outgoing cross-references to traversenointeger0
schemethe scheme of the URI to exportnostringdocumentScheme template property
sinceLast modified date used to filter URIs to export, only used if "path" is specified and points to a foldernostring
withComma-separated list of facets used to filter URIs to export, only used if "path" is specified and points to a foldernostring
withoutnot usednostring
xref-typesComma-separated list of cross-references to traverse (none,embed,transclude)nostring

Permission

Undocumented permissions requirements.

Response

Undocumented XML response

Error Handling

No specific errors expected for this generator.

Created on , last edited on