Skip to main content

 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.

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

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

Parameters

NameDescriptionRequiredTypeDefault value
binary-metadata-onlyFlag to specify if only metadata of non-PSML documents should be included in the export. Requires PageSeeder v5.99 or higher.nobooleanfalse
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 version to compare with, if the value is a float or ISO 8601 date and none match, the closest previous release is loadednostring
excludesComma-separated list of filename 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 end the exportnobooleantrue
forward-depthThe depth of outgoing cross-references to traversenointeger0
hostThe host of the URI to export nostringsee below
image-metadata-onlyFlag to specify if only metadata of referenced images should be included in the export. DEPRECATED use binary-metadata-only instead.nobooleanfalse
includesComma-separated list of filename 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 exportnointegersee below
publicationidThe ID of the publication for release and compare parametersnopublicationid
releaseValue of the version to export, if the value is a float or ISO 8601 date and none match, the closest previous release is loadednostring
reverse-depthThe depth of reverse 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 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

scheme

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

host

If specified, the host must be one of the define PageSeeder hosts. It defaults to the webSiteAddress 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 documentPort template property.

Permission

Permissions requirements to be updated.

Response

This service returns the following XML (even if an asynchronous process has not been started):

<thread ... status="[status]">
  ...
  [<processing current="[number processed]" 
               total="[total processing]"/>]

  [<packaging  current="[number packaged]" 
               total="[total packaging]"/>]

  [<zip>[zip file name]</zip>]
</thread>

When status="complete" the export 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