Web service API

How to use PageSeeder's Web service API

uri export

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

com.pageseeder.export.Export

Description

Export a document (URI) and any of its referenced documents.

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
compareValue of the release to compare with, if the value is a float and none match, the closest previous release is loadednostring
contextContext path without the site prefixnopathURI folder
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 
includesA comma-separated list of file name patterns to include in the export, only used if "path" is specified and points to a foldernostrings
load-alternatesFlag to specify if referenced files with XRef type="alternate" should be included in the exportnobooleantrue
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
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 export. DEPRECATED use load-images instead.nobooleantrue
reverse-depthThe depth of inward cross-references to traversenointeger0
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)

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.

Created on , last edited on