getArchiveExportSettings
Get the export settings used or to be used by an archive export.
This operation can be used with either an export or import archive. It can be used anytime after
createExportArchive or
createImportArchive is called, as long as it is within the same transaction and the archive has not been closed.
Location
/services/webservices/system/admin/archive/operations/
Request Element
archiveId: The ID of the archive.
Response Elements
settings: Description of what was or will be exported for this archive. The settings have the following structure:
• name: The name of the export archive.
• description: A verbose description of the archive.
• type:
— BACKUP: All information in this archive replaces the server information when imported.
— ROOT: Resources within the archive cannot be relocated when reimported.
— PACKAGE: Resources within the archive can be relocated when reimported.
• resources (optional): List of exported resources.
— all (optional): If set, all resources on the server were or will be exported.
— resource (0 or more): List of individual exported resources.
path: The path to the resource.
type: The type of the resource.
includeChildren (optional): If TRUE or unset, recursively export all child resources. If FALSE, do not include any children.
• serverAttributes (optional): List of exported server attributes.
— all (optional): If set, all server attributes were or will be exported.
— attributes (optional): A space-delimited list of exported server attribute names. See
Attributes Element.
• exportOptions (optional): A space-delimited list of archive options (name elements).
• importHints (optional): Hints that can be used during import. See
Import Hints.
• createInfo (optional): Information about the creation of the exported archive.
— archiveDomain: The domain of the user that created this archive.
— archiveUser: The name of the that created this archive.
— archiveVersion: The version of the archiver used to create this archive.
— createDate: When the archive was created.
— sourceJvm: What Java Virtual Machine was used to create this archive.
— sourceOperationSystem: What operating system was used to create the archive.
Faults
NotFound: If archive for the archive ID does not exist.