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
contextContext path without the site prefixyespathURI folder
paththe path of the URI to export (without the site prefix), needed if "uris" is not specifiedmaybepath
urisComma-separated list of URI IDs to export, needed if "path" is not specifiedmaybelongs
compareValue of the release to compare with, if the value is a float and none match, the closest previous release is loadednostring
excludesA comma-separated list of file name patterns to exclude from the export, only used if "path" is specified and points to a foldernostrings
fail-on-errorFlag to specify if the first error should kill the exportnobooleanfalse
forward-depthThe depth of outgoing cross-references to traversenointeger 0 
hostthe host of the URI to exportnostringsee below
includesA comma-separated list of file name patterns to include in the export, only used if "path" is specified and points to a foldernostrings
metadata-onlyFlag to specify if only metadata PSML should be included in the exportnobooleanfalse
portthe port of the URI to exportnoportsee below
publicationidThe ID of the publication for release and compare parameters.nopublicationid
releaseValue of the version to export, if the value is a float and none match, the closest previous release is loadednostring
resolve-imagesFlag to specify if referenced images should be included in the exportnobooleantrue
reverse-depthThe depth of inward cross-references to traversenointeger0
schemethe scheme of the URI to exportnostringsee below
sinceLast modified date used to filter URIs to export, only used if "path" is specified and points to a foldernodate or datetime
withComma-separated list of facets used to filter URIs to export, only used if "path" is specified and points to a foldernostrings
xref-typesA comma-separated list of cross-references to traverseno 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