uri export
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 5.1102 | 6.1000 | xml |
Description
Export a document (URI) and any of its referenced documents.
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
| Name | Description | Required | Type | Default |
|---|---|---|---|---|
| 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 |
| 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 | |
| context | Context path without the site prefix | no | path | URI folder |
| excludes | A comma-separated list of filename patterns to exclude from the export, only used if path is specified and points to a folder | no | strings | |
| fail-on-error | Flag to specify if the first error should stop the export | no | boolean | false |
| forward-depth | The depth of outgoing cross-references to traverse | no | integer | 0 |
| 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 | A comma-separated list of filename patterns to include in the export, only used if path is specified and points to a folder | no | strings | |
| interpublication-xrefs | Flag whether to resolve{parentnumber}, {prefix} and {heading} templates of xrefs between publications. Uses the default publication of the target. | no | boolean | false |
| load-alternates | Flag to specify if referenced files with xref type="alternate" should be included in the export | no | boolean | true |
| 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 | |
| resolve-images | Flag to specify if referenced images should be included in the export. DEPRECATED use load-images instead | no | boolean | true |
| 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 | date or datetime | |
| 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 | strings | |
| xref-types | A comma-separated list of cross-references to traverse | no | strings | (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.
Permission
Only the member or an administrator can invoke this service and the member must have access to the uri.
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 filename]</zip>]
</thread>
When status="complete" the export can be downloaded using the URL:
[scheme]://[my server]/ps/member-resource/[group name]/[zip filename]
For example:
https://example.org/ps/member-resource/example-specs/export-1449617820208.zip
Error Handling
No specific errors expected for this service.