uris export
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 5.9910 | 6.1000 | xml |
Description
Export document(s) using path or uris parameters.
This service exports the document(s) specified using the Universal Portable Format.
Use this service instead of Service: /members/{member}/export [GET] if the uris parameter could be very long so that the maximum URL length for GET is not exceeded.
This 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
| Name | Description | Required | Type | Default value |
|---|---|---|---|---|
| binary-metadata-only | Flag to specify if only metadata of non-PSML documents should be included in the export. Requires PageSeeder v5.99 or higher. | no | boolean | false |
| context | Context of the upload (without the site prefix), required if uris is specified | maybe | string | |
| path | The path of the URI to export (without the site prefix), required if uris is not specified | maybe | string | |
| uris | Comma-separated list of URI IDs of documents to export, required if path is not specified | maybe | string | |
| compare | Value of the version to compare with, if the value is a float or ISO 8601 date and none match, the closest previous version is loaded | no | string | |
| excludes | Comma-separated list of filename 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 end the export | no | boolean | true |
| forward-depth | The depth of outgoing cross-references to traverse | no | integer | 0 |
| host | The host of the URI to export | no | string | see below |
| image-metadata-only | Flag to specify if only metadata of referenced images should be included in the export. DEPRECATED use binary-metadata-only instead. | no | boolean | false |
| includes | Comma-separated list of filename patterns to include in the export, only used if path is specified and points to a folder | no | string | |
| interpublication-xrefs | Flag whether to resolve templates of xrefs between publications. Uses the default publication of the target. | no | boolean | false |
| 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 |
| position | Position in the publication for numbering | no | integer | 1 |
| process-publication | Whether to process publication numbering and placeholders (requires publicationid). Requires PageSeeder v6.1 or higher. | no | boolean | false |
| publicationid | The ID of the publication for processing and versions | no | publicationid | |
| reverse-depth | The depth of reverse 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 | |
| version | Value of the version to export. If the value is a float or ISO 8601 date and none match, the closest previous version is loaded | 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 | |
| xref-types | Comma-separated list of cross-references to traverse (none,embed,transclude) | no | string | [all types] |
If process-publication="true" then transcluded content will be included in documents (except if compare specified), however transclude should still be specified in xref-types to follow xrefs in that content.
host
If specified, the host must be one of the define PageSeeder hosts. It defaults to the webSiteAddress template property.
Permission
User must have access to view the documents being exported.
Response
This service returns the following XML (even if an asynchronous process has not been started):
<thread ... status="[status]" groupid="[group ID]">
...
[<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 ID or name]/[zip file name]
For example:
https://example.org/ps/member-resource/example-specs/export-1449617820208.zip
The group is the default group or 1st accessible group of any document exported and is returned in the <thread> element.
Error Handling
No specific errors expected for this service.
Check the process logs for errors.